\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__1\">userName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__3\">Username you want to use to authenticate the REST message.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__1\">userPass</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__3\">Password for the specified user.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr\"><caption><span class=\"table--title-label\">Table 24. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setBasicAuth("username","password");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setEccCorrelator_S\" id=\"r_RMV2-setEccCorrelator_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setEccCorrelator_S\">RESTMessageV2 - setEccCorrelator(String correlator)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Associates outbound requests and the resulting response record in the ECC queue. This\n method only applies to REST messages sent through a <span class=\"ph\">MID Server</span>.</p>\n <section class=\"section\">\n <p class=\"p\">The correlator provided populates the <span class=\"ph uicontrol\">Agent correlator</span> field on the\n ECC queue record for the response. Provide a unique correlator for each outbound request to\n associate the correct results in the ECC queue with the request when designing asynchronous\n automation through a MID Server.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 25. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__1\">correlator</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__3\">Unique identifier</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr\"><caption><span class=\"table--title-label\">Table 26. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setEccCorrelator("unique_identifier");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setEccParameter_S_S\" id=\"r_RMV2-setEccParameter_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setEccParameter_S_S\">RESTMessageV2 - setEccParameter(String name, String value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Overrides a value from the database by writing to the REST message payload. This method\n only applies to REST messages sent through a MID Server.</p>\n <section class=\"section\">\n <p class=\"p\">Use this method when a value from the REST message in the database is invalid, such as when\n the endpoint URL is longer than the maximum REST endpoint field length. You can set only the\n endpoint URL using this method by passing source as the name parameter.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 27. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__3\">The name of the parameter, such as source.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__3\">The value to assign to the specified parameter.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr\"><caption><span class=\"table--title-label\">Table 28. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setEccParameter("source","http://very.long.endpoint.url");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setEndpoint_String_endpoint\" id=\"r_RMV2-setEndpoint_String_endpoint\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setEndpoint_String_endpoint\">RESTMessageV2 - setEndpoint(String endpoint)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the endpoint for the REST message.</p>\n <section class=\"section\">\n <p class=\"p\">By default, the REST message uses the endpoint specified in the REST message record. Use\n this method to override this default. You must call this method when using the <a class=\"xref\" href=\"#r_RMV2-RESTMessageV2\" title=\"Instantiates an empty RESTMessageV2 object.\">RESTMessageV2 - RESTMessageV2()</a> constructor with no parameters.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 29. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__1\">endpoint</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__3\">The URL of the REST provider you want to interface with.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr\"><caption><span class=\"table--title-label\">Table 30. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2();\nsm.setEndpoint("http://web.service.endpoint");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setHttpMethod_String_method\" id=\"r_RMV2-setHttpMethod_String_method\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setHttpMethod_String_method\">RESTMessageV2 - setHttpMethod(String method)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the HTTP method this REST message performs, such as GET or PUT.</p>\n <section class=\"section\">\n <p class=\"p\">You must set an HTTP method when using the <a class=\"xref\" href=\"#r_RMV2-RESTMessageV2\" title=\"Instantiates an empty RESTMessageV2 object.\">RESTMessageV2 - RESTMessageV2()</a> constructor with no parameters.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 31. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__1\">method</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__3\">HTTP method to perform.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr\"><caption><span class=\"table--title-label\">Table 32. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2();\nsm.setHttpMethod("post");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setHttpTimeout_N\" id=\"r_RMV2-setHttpTimeout_N\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setHttpTimeout_N\">RESTMessageV2 - setHttpTimeout(Number timeoutMs)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the amount of time the REST message waits for a response from the web service\n provider before the request times out.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 33. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__1\">timeoutMs</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__3\">Amount of time in milliseconds before the call to the REST provider times out.<div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This value sets a timeout on the socket and only times out if the socket\n does not receive data within the specified time. For environments in which\n responses are streamed, it's possible that connections last much longer than the\n timeout value.</div></div></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr\"><caption><span class=\"table--title-label\">Table 34. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">To use the following example, replace <var class=\"keyword varname\"><REST_message_record></var> with the\n name of the REST message record from your instance.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Might throw exception if message doesn't exist or not visible due to scope.\nvar sm = new sn_ws.RESTMessageV2("<REST_message_record>", "get");\nsm.setHttpTimeout(6000);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RMV2-setLogLevel_S\" id=\"RMV2-setLogLevel_S\">\n <h2 class=\"title topictitle2\" id=\"title_RMV2-setLogLevel_S\">RESTMessageV2 - setLogLevel(String level)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the log level for this message and the corresponding response.</p>\n <section class=\"section\">\n <p class=\"p\">Setting a log level using the RESTMessageV2 API overrides the log level configured on the\n REST message record. This log level may not apply if the endpoint domain is excluded, or if\n the property <span class=\"keyword parmname\">glide.outbound_http_log.override</span> is true. To view outbound\n web service logs, navigate to <span class=\"ph menucascade\"><span class=\"ph uicontrol\">System Logs</span><abbr> > </abbr><span class=\"ph uicontrol\">Outbound HTTP Requests</span></span>.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RMV2-setLogLevel_S__table_jsf_y55_rw\"><caption><span class=\"table--title-label\">Table 35. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__1\">level</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__3\">The log level. Valid values are basic, elevated, and all.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RMV2-setLogLevel_S__table_ksf_y55_rw\"><caption><span class=\"table--title-label\">Table 36. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var rm = new sn_ws.RESTMessageV2();\nrm.setLogLevel('all');</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setMIDServer_S\" id=\"r_RMV2-setMIDServer_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setMIDServer_S\">RESTMessageV2 - setMIDServer(String midServer)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Configures the REST message to communicate through a <span class=\"ph\">MID Server</span>.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setMIDServer_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 37. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__1\">midServer</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__3\">Name of the <span class=\"ph\">MID Server</span> to use. Your instance must have an active\n <span class=\"ph\">MID Server</span> with the specified name.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setMIDServer_S__table_el5_bmh_dr\"><caption><span class=\"table--title-label\">Table 38. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setMIDServer("mid_server_name");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setMutualAuth_S\" id=\"r_RMV2-setMutualAuth_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setMutualAuth_S\">RESTMessageV2 - setMutualAuth(String profileName)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the mutual authentication protocol profile for the REST message.</p>\n <section class=\"section\">\n <p class=\"p\">Setting a protocol profile using this method overrides the protocol profile selected for\n the REST message record.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setMutualAuth_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 39. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__1\">profileName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__3\">The <span class=\"ph uicontrol\">Name</span> of the protocol profile to use for mutual\n authentication.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr\"><caption><span class=\"table--title-label\">Table 40. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setMutualAuth("mutual_auth_profile_name");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setQueryParameter_S_S\" id=\"r_RMV2-setQueryParameter_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setQueryParameter_S_S\">RESTMessageV2 - setQueryParameter(String name, String value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Appends a parameter to the end of the request URL with the form name=value.</p>\n <section class=\"section\">\n <p class=\"p\">For example, the code\n setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory"); appends\n the text sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory to the request URL.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 41. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__3\">Name of the URL parameter to pass.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__3\">Value to assign the URL parameter.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr\"><caption><span class=\"table--title-label\">Table 42. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2();\n//Set up message, including endpoint and authentication\nsm.setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setRequestBody_String_body\" id=\"r_RMV2-setRequestBody_String_body\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setRequestBody_String_body\">RESTMessageV2 - setRequestBody(String body)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the body content to send to the web service provider when using PUT or POST HTTP\n methods.</p>\n <section class=\"section\">\n <p class=\"p\">When you set the body content using this method, variables in the body are not substituted\n for parameters from the REST message function record. You must explicitly define all values\n within the REST message body.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 43. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__1\">body</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__3\">Request body to send.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr\"><caption><span class=\"table--title-label\">Table 44. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Update user","post"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar body = "<Message body content>";\nsm.setRequestBody(body);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setReqBodyFromAttachment_S\" id=\"r_RMV2-setReqBodyFromAttachment_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setReqBodyFromAttachment_S\">RESTMessageV2 - setRequestBodyFromAttachment(String attachmentSysId)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the request body using an existing attachment record.</p>\n <section class=\"section\">\n <p class=\"p\" id=\"r_RMV2-setReqBodyFromAttachment_S__p_RMv2_MID_roles_req\">When you use this function with a REST message that is sent\n through a <span class=\"ph\">MID Server</span>, the <span class=\"ph\">MID Server</span> user must have any roles\n required to read attachment records.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s\"><caption><span class=\"table--title-label\">Table 45. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__1\">attachmentSysId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__3\">Sys_id of the Attachment [sys_attachment] record you want to send in this REST\n message.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s\"><caption><span class=\"table--title-label\">Table 46. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">(function sampleRESTMessageV2() {\n try {\n var request = new sn_ws.RESTMessageV2();\n request.setHttpMethod('post');\n request.setEndpoint('<web service endpoint URL>');\n request.setRequestBodyFromAttachment('<attachment sys_id>');\n \n var response = request.execute();\n var httpResponseStatus = response.getStatusCode();\n \n gs.info("http response status_code: " + httpResponseStatus); \n }\n catch (ex) {\n var message = ex.getMessage();\n gs.info(message);\n }\n})();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setRequestHeader_S_S\" id=\"r_RMV2-setRequestHeader_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setRequestHeader_S_S\">RESTMessageV2 - setRequestHeader(String name, String value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets an HTTP header in the REST message to the specified value.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 47. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__3\">Name of the header.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__3\">Value to assign to the specified header.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr\"><caption><span class=\"table--title-label\">Table 48. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setRequestHeader("Accept","Application/json");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMv2-setRequestorProfile_S_S\" id=\"r_RMv2-setRequestorProfile_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMv2-setRequestorProfile_S_S\">RESTMessageV2 - setRequestorProfile(String requestorContext, String requestorId)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Overrides the default requestor profile for the REST message in order to retrieve an\n OAuth access token associated with a different requestor.</p>\n <section class=\"section\">\n <p class=\"p\">This method applies only to REST messages configured to use OAuth 2.0 authentication. This\n method is optional and is unnecessary in most configurations.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt\"><caption><span class=\"table--title-label\">Table 49. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__1\">requestorContext</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__3\"></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__1\">requestorId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt\"><caption><span class=\"table--title-label\">Table 50. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setStringParameter_S_S\" id=\"r_RMV2-setStringParameter_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setStringParameter_S_S\">RESTMessageV2 - setStringParameter(String name, String value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets a REST message function variable with the specified name from the REST message\n record to the specified value.</p>\n <section class=\"section\">\n <p class=\"p\">XML reserved characters in the value are converted to the equivalent escaped characters.\n Use <span class=\"keyword apiname\">setStringParameterNoEscape</span> to set a variable without escaping XML\n reserved characters.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 51. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__3\">Name of the REST message variable. This parameter must be defined in the REST\n message record before you can assign a value to it.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__3\">Value to assign the variable.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr\"><caption><span class=\"table--title-label\">Table 52. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setStringParameter("s","NOW");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RMV2-setStrParamNoEscape_S_S\" id=\"r_RMV2-setStrParamNoEscape_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RMV2-setStrParamNoEscape_S_S\">RESTMessageV2 - setStringParameterNoEscape(String name, String value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets a REST message function variable with the specified name from the REST message\n record to the specified value.</p>\n <section class=\"section\">\n <p class=\"p\">This method is equivalent to <span class=\"keyword apiname\">setStringParameter</span> but does not escape XML\n reserved characters.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 53. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__3\">Name of the REST message variable. This parameter must be defined in the REST\n message record before you can assign a value to it.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__3\">Value to assign the variable.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr\"><caption><span class=\"table--title-label\">Table 54. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, replace <var class=\"keyword varname\">REST_message_record</var> with the name of\n the REST message record from your instance.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setStringParameterNoEscape("s","NOW");</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RESTMessageV2 - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206648\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206648\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"c_RESTMessageV2API\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"RESTMessageV2,disableForcedVariableSubstitution(),RESTMessagev2,execute(),getEndpoint(),getRequestBody(),getRequestHeader(String headerName),getRequestHeaders(),RESTMessageV2(),RESTMessageV2(String name, String methodName),saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName, String encryptContext),setAuthenticationProfile(String type, String profileId),setBasicAuth(String userName, String userPass),setEccCorrelator(String correlator),setEccParameter(String name, String value),setEndpoint(String endpoint),setHttpMethod(String method),setHttpTimeout(Number timeoutMs),setLogLevel(String level),setMIDServer(String midServer),setMutualAuth(String profileName),setQueryParameter(String name, String value),setRequestBody(String body),setRequestBodyFromAttachment,setRequestHeader(String name, String value),setRequestorProfile(String requestorContext, String requestorId),setStringParameter(String name, String value),setStringParameterNoEscape(String name, String value)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RESTMessageV2 API allows you to send outbound REST messages using JavaScript.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"RESTMessageV2, disableForcedVariableSubstitution(), RESTMessagev2, execute(), getEndpoint(), getRequestBody(), getRequestHeader(String headerName), getRequestHeaders(), RESTMessageV2(), RESTMessageV2(String name, String methodName), saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName, String encryptContext), setAuthenticationProfile(String type, String profileId), setBasicAuth(String userName, String userPass), setEccCorrelator(String correlator), setEccParameter(String name, String value), setEndpoint(String endpoint), setHttpMethod(String method), setHttpTimeout(Number timeoutMs), setLogLevel(String level), setMIDServer(String midServer), setMutualAuth(String profileName), setQueryParameter(String name, String value), setRequestBody(String body), setRequestBodyFromAttachment, setRequestHeader(String name, String value), setRequestorProfile(String requestorContext, String requestorId), setStringParameter(String name, String value), setStringParameterNoEscape(String name, String value)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\",\n \"page_key\": 41206648,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 22081,\n \"img_count\": 0,\n \"read_time\": 11,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 2879\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RESTMessageV2 - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api dita\\\" aria-labelledby=\\\"title_c_RESTMessageV2API\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_c_RESTMessageV2API\\\" id=\\\"c_RESTMessageV2API\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_c_RESTMessageV2API\\\">RESTMessageV2 - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RESTMessageV2</span> API allows you to send outbound REST messages using\\n JavaScript.</p>\\n <p class=\\\"p\\\">Use the RESTResponseV2 API to manage the response returned by the REST provider.</p>\\n <p class=\\\"p\\\">The User-Agent value is "ServiceNow/1.0". To change this, add the glide.http.user.agent system\\n property in the System Properties [sys_properties] table.</p>\\n <p class=\\\"p\\\">This API runs in the <code class=\\\"ph codeph\\\">sn_ws</code> namespace.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_RestMessageV2-disableForcedVariableSubstitution\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RestMessageV2-disableForcedVariableSubstitution\\\">RESTMessageV2 - disableForcedVariableSubstitution()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Disables forced variable substitution in outbound REST messages.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Use of curly brackets or dollar signs in your request may inadvertently return a truncated output. If your request erroneously truncates the response or splits the response onto new lines, refer to <a class=\\\"xref true-external\\\" href=\\\"https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1442596\\\" target=\\\"_blank\\\">this Community article</a> for a potential solution.</div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__table_bvg_43g_z2b\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__table_bvg_43g_z2b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__table_bvg_43g_z2b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__table_bvg_43g_z2b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RestMessageV2-disableForcedVariableSubstitution__table_bvg_43g_z2b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RestMessageV2-disableForcedVariableSubstitution__table_bvg_43g_z2b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RestMessageV2-disableForcedVariableSubstitution__table_bvg_43g_z2b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__table_cvg_43g_z2b\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__table_cvg_43g_z2b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__table_cvg_43g_z2b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RestMessageV2-disableForcedVariableSubstitution__table_cvg_43g_z2b__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RestMessageV2-disableForcedVariableSubstitution__table_cvg_43g_z2b__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RestMessageV2-disableForcedVariableSubstitution__example_sht_xks_pyb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get");\\nsm.disableForcedVariableSubstitution();\\nvar response = sm.execute();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-execute\\\" id=\\\"r_RMV2-execute\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-execute\\\">RESTMessageV2 - execute()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sends the REST message to the endpoint.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-execute__table_vy2_525_jqa\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-execute__table_vy2_525_jqa__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-execute__table_vy2_525_jqa__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-execute__table_vy2_525_jqa__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-execute__table_vy2_525_jqa__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-execute__table_vy2_525_jqa__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-execute__table_vy2_525_jqa__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-execute__table_qlp_mhh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-execute__table_qlp_mhh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-execute__table_qlp_mhh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-execute__table_qlp_mhh_dr__entry__1\\\">RESTResponse</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-execute__table_qlp_mhh_dr__entry__2\\\">The response returned by the REST provider.</td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-executeAsync\\\" id=\\\"r_RMV2-executeAsync\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-executeAsync\\\">RESTMessageV2 - executeAsync()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sends the REST message to the endpoint asynchronously. The instance does not wait for a\\n response from the web service provider when making asynchronous calls.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-executeAsync__table_vy2_525_jqb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-executeAsync__table_vy2_525_jqb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-executeAsync__table_vy2_525_jqb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-executeAsync__table_vy2_525_jqb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-executeAsync__table_vy2_525_jqb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-executeAsync__table_vy2_525_jqb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-executeAsync__table_vy2_525_jqb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-executeAsync__table_rys_lhh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-executeAsync__table_rys_lhh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-executeAsync__table_rys_lhh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-executeAsync__table_rys_lhh_dr__entry__1\\\">RESTResponse</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-executeAsync__table_rys_lhh_dr__entry__2\\\">The response returned by the REST provider.</td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance. When using <code class=\\\"ph codeph\\\">executeAsync</code>,\\n consider processing the response body in a separate business rule to take advantage of the\\n asynchronous call.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.executeAsync(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\\n</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-getEndpoint\\\" id=\\\"r_RMV2-getEndpoint\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-getEndpoint\\\">RESTMessageV2 - getEndpoint()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the URL of the endpoint for the REST message.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-getEndpoint__table_vy2_525_jqc\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getEndpoint__table_vy2_525_jqc__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getEndpoint__table_vy2_525_jqc__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getEndpoint__table_vy2_525_jqc__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getEndpoint__table_vy2_525_jqc__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getEndpoint__table_vy2_525_jqc__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getEndpoint__table_vy2_525_jqc__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-getEndpoint__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getEndpoint__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getEndpoint__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getEndpoint__table_qpt_3f5_jq__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getEndpoint__table_qpt_3f5_jq__entry__2\\\">The URL of the REST web service provider.</td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar endpoint = sm.getEndpoint();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-getRequestBody\\\" id=\\\"r_RMV2-getRequestBody\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-getRequestBody\\\">RESTMessageV2 - getRequestBody()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the content of the REST message body.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-getRequestBody__table_vy2_525_jqd\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestBody__table_vy2_525_jqd__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestBody__table_vy2_525_jqd__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestBody__table_vy2_525_jqd__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestBody__table_vy2_525_jqd__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestBody__table_vy2_525_jqd__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestBody__table_vy2_525_jqd__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-getRequestBody__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestBody__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestBody__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestBody__table_qpt_3f5_jq__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestBody__table_qpt_3f5_jq__entry__2\\\">the REST message body.</td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar body = sm.getRequestBody();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-getRequestHeader_S\\\" id=\\\"r_RMV2-getRequestHeader_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-getRequestHeader_S\\\">RESTMessageV2 - getRequestHeader(String headerName)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the value for an HTTP header specified in the REST message.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">By default, this method cannot return the value for a header set automatically by the\\n system. To grant this method access to all headers, set the property glide.http.log_debug to\\n true.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-getRequestHeader_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeader_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeader_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeader_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeader_S__table_vy2_525_jq__entry__1\\\">headerName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeader_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeader_S__table_vy2_525_jq__entry__3\\\">Request header you want to get the value for.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-getRequestHeader_S__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeader_S__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeader_S__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeader_S__table_qpt_3f5_jq__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeader_S__table_qpt_3f5_jq__entry__2\\\">The value of the specified header.</td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar header = sm.getRequestHeader("Accept");</code></pre>\\n </div>\\n </div>\\n \\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-getRequestHeaders\\\" id=\\\"r_RMV2-getRequestHeaders\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-getRequestHeaders\\\">RESTMessageV2 - getRequestHeaders()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets HTTP headers that were set by the REST client and the associated\\n values.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">This method does not return headers set automatically by the system. To configure this\\n method to return all headers, set the property glide.http.log_debug to true.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-getRequestHeaders__table_vy2_525_jqe\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeaders__table_vy2_525_jqe__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeaders__table_vy2_525_jqe__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeaders__table_vy2_525_jqe__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeaders__table_vy2_525_jqe__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeaders__table_vy2_525_jqe__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeaders__table_vy2_525_jqe__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-getRequestHeaders__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeaders__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-getRequestHeaders__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeaders__table_qpt_3f5_jq__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-getRequestHeaders__table_qpt_3f5_jq__entry__2\\\">An Object that maps the name of each header to the associated value.</td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar headers = sm.getRequestHeaders();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_r_RMV2-RESTMessageV2\\\" id=\\\"r_RMV2-RESTMessageV2\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-RESTMessageV2\\\">RESTMessageV2 - RESTMessageV2()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Instantiates an empty RESTMessageV2 object.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">When using an object instantiated this way, you must manually specify an HTTP method and\\n endpoint.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-RESTMessageV2__table_vy2_525_jqf\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-RESTMessageV2__table_vy2_525_jqf__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-RESTMessageV2__table_vy2_525_jqf__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-RESTMessageV2__table_vy2_525_jqf__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2__table_vy2_525_jqf__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2__table_vy2_525_jqf__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2__table_vy2_525_jqf__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_r_RMV2-RESTMessageV2_S_S\\\" id=\\\"r_RMV2-RESTMessageV2_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-RESTMessageV2_S_S\\\">RESTMessageV2 - RESTMessageV2(String name, String methodName)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Instantiates a RESTMessageV2 object using information from a REST message\\n record.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">You must have a REST message record defined before you can use this constructor.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__3\\\">The name of the REST message record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__1\\\">methodName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-RESTMessageV2_S_S__table_vy2_525_jq__entry__3\\\">The name of the HTTP method to use, such as GET/get or PUT/put - case\\n insensitive.</td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-saveRespBodyAsAttach_S_S_S\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-saveRespBodyAsAttach_S_S_S\\\">RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String\\n fileName)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Configures the REST message to save the returned response body as an attachment\\n record.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">When you use this function with a REST message that is sent through a MID server, the MID server user must have any roles required to read and write attachment records, as well as any roles required to read and write records on\\n the table specified in the <span class=\\\"keyword parmname\\\">tableName</span> parameter.</p>\\n <p class=\\\"p\\\">The response body does not need to be a binary file to be saved as an attachment. Response bodies using text formats, such as JSON or XML can also be saved. If the instance fails to save the attachment, call\\n <span class=\\\"keyword apiname\\\">getErrorMessage()</span> on the related RESTResponseV2 object for error details.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__1\\\">tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__3\\\">Specify the table that contains the record you want to attach the saved file\\n to.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__1\\\">recordSysId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__3\\\">Specify the sys_id of the record you want to attach the saved file to.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__1\\\">fileName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_yg1_rp3_5s__entry__3\\\">Specify the file name to give to the saved file.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_zg1_rp3_5s\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_zg1_rp3_5s__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_zg1_rp3_5s__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_zg1_rp3_5s__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S__table_zg1_rp3_5s__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">(function sampleRESTMessageV2() {\\n try{\\n var request = new sn_ws.RESTMessageV2(); \\n request.setHttpMethod('get');\\n\\n var attachment_sys_id = '<attachment_record_sys_id>', \\n tablename = 'incident',\\n recordSysId = '<incident_sys_id>', \\n response, \\n httpResponseStatus, \\n filename ='<filename>';\\n\\n //endpoint - ServiceNow REST Attachment API \\n request.setEndpoint('https://<instance_name>.service-now.com/api/now/attachment/' + attachment_sys_id +'/file'); \\n request.setBasicAuth('<username>', '<password>');\\n\\n //RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName) \\n request.saveResponseBodyAsAttachment(tablename, recordSysId, filename); \\n\\n response = request.execute(); \\n httpResponseStatus = response.getStatusCode(); \\n \\n gs.info(" http response status_code: " + httpResponseStatus); \\n }\\n catch(ex){\\n var message = ex.getMessage(); \\n gs.info(message); \\n }\\n})();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-saveRespBodyAsAttach_S_S_S_S\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-saveRespBodyAsAttach_S_S_S_S\\\">RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String\\n fileName, String encryptContext)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Configures the REST message to save the returned response body as an encrypted\\n attachment record.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">When you use this function with a REST message that is sent through a MID server, the MID server user must have any roles required to read and write attachment records, as well as any roles required to read and write records on\\n the table specified in the <span class=\\\"keyword parmname\\\">tableName</span> parameter.</p>\\n <p class=\\\"p\\\">The response body does not need to be a binary file to be saved as an attachment. Response bodies using text formats, such as JSON or XML can also be saved. If the instance fails to save the attachment, call\\n <span class=\\\"keyword apiname\\\">getErrorMessage()</span> on the related RESTResponseV2 object for error details.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s\\\"><caption><span class=\\\"table--title-label\\\">Table 19. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__1\\\">tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__3\\\">Specify the table that contains the record you want to attach the saved file\\n to.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__1\\\">recordSysId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__3\\\">Specify the sys_id of the record you want to attach the saved file to.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__1\\\">fileName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__3\\\">Specify the file name to give to the saved file.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__1\\\">encryptContext</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_yg1_rp3_5s__entry__3\\\">Specify the sys_id of an encryption context. The saved file is encrypted using\\n this context.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_zg1_rp3_5s\\\"><caption><span class=\\\"table--title-label\\\">Table 20. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_zg1_rp3_5s__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_zg1_rp3_5s__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_zg1_rp3_5s__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-saveRespBodyAsAttach_S_S_S_S__table_zg1_rp3_5s__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setAuthenticationProfile_S_S\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setAuthenticationProfile_S_S\\\">RESTMessageV2 - setAuthenticationProfile(String type, String profileId)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the credentials for the REST message using an existing basic auth or OAuth 2.0\\n profile.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt\\\"><caption><span class=\\\"table--title-label\\\">Table 21. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__1\\\">type</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__3\\\">The type of authentication profile to use. Valid values are 'basic' to use\\n basic authentication, or 'oauth2' to use OAuth 2.0.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__1\\\">profileId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_qym_34c_jt__entry__3\\\">The sys_id of an authentication profile record. When using basic auth, specify\\n the sys_id of a Basic Auth Configuration [sys_auth_profile_basic] record. When using\\n OAuth 2.0, specify the sys_id of a OAuth Entity Profile [oauth_entity_profile]\\n record.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S__table_rym_34c_jt\\\"><caption><span class=\\\"table--title-label\\\">Table 22. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S__table_rym_34c_jt__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setAuthenticationProfile_S_S__table_rym_34c_jt__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_rym_34c_jt__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setAuthenticationProfile_S_S__table_rym_34c_jt__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var requestBody;\\nvar responseBody;\\nvar status;\\nvar sm;\\ntry{\\n // Might throw exception if message doesn't exist or not visible due to scope.\\n\\tsm = new sn_ws.RESTMessageV2("<REST_message_record>", "get"); \\n\\n //set auth profile to an OAuth 2.0 profile record.\\n\\tsm.setAuthenticationProfile('oauth2', '1234adsf123212131123qasdsf'); \\n\\n\\tsm.setStringParameter("symbol", "NOW");\\n\\tsm.setStringParameterNoEscape("xml_data","<data>test</data>");\\n\\n //In milliseconds. Wait at most 10 seconds for response from http request.\\n\\tsm.setHttpTimeout(10000); \\n //Might throw exception if http connection timed out or some issue \\n //with sending request itself because of encryption/decryption of password.\\n\\tresponse = sm.execute();\\t\\n responseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\\n\\tstatus = response.getStatusCode();\\n} catch(ex) {\\n\\tresponseBody = ex.getMessage();\\n\\tstatus = '500';\\n} finally {\\n\\trequestBody = sm ? sm.getRequestBody():null;\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setBasicAuth_S_S\\\" id=\\\"r_RMV2-setBasicAuth_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setBasicAuth_S_S\\\">RESTMessageV2 - setBasicAuth(String userName, String userPass)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets basic authentication headers for the REST message.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Setting security values using this method overrides basic authentication values defined for\\n the REST message record.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 23. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__1\\\">userName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__3\\\">Username you want to use to authenticate the REST message.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__1\\\">userPass</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_vy2_525_jq__entry__3\\\">Password for the specified user.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 24. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setBasicAuth_S_S__table_arp_cmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setBasicAuth("username","password");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setEccCorrelator_S\\\" id=\\\"r_RMV2-setEccCorrelator_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setEccCorrelator_S\\\">RESTMessageV2 - setEccCorrelator(String correlator)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Associates outbound requests and the resulting response record in the ECC queue. This\\n method only applies to REST messages sent through a <span class=\\\"ph\\\">MID Server</span>.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">The correlator provided populates the <span class=\\\"ph uicontrol\\\">Agent correlator</span> field on the\\n ECC queue record for the response. Provide a unique correlator for each outbound request to\\n associate the correct results in the ECC queue with the request when designing asynchronous\\n automation through a MID Server.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 25. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__1\\\">correlator</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccCorrelator_S__table_vy2_525_jq__entry__3\\\">Unique identifier</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 26. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccCorrelator_S__table_x3m_cmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setEccCorrelator("unique_identifier");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setEccParameter_S_S\\\" id=\\\"r_RMV2-setEccParameter_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setEccParameter_S_S\\\">RESTMessageV2 - setEccParameter(String name, String value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Overrides a value from the database by writing to the REST message payload. This method\\n only applies to REST messages sent through a MID Server.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Use this method when a value from the REST message in the database is invalid, such as when\\n the endpoint URL is longer than the maximum REST endpoint field length. You can set only the\\n endpoint URL using this method by passing source as the name parameter.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 27. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__3\\\">The name of the parameter, such as source.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_vy2_525_jq__entry__3\\\">The value to assign to the specified parameter.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 28. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEccParameter_S_S__table_b1j_cmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setEccParameter("source","http://very.long.endpoint.url");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setEndpoint_String_endpoint\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setEndpoint_String_endpoint\\\">RESTMessageV2 - setEndpoint(String endpoint)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the endpoint for the REST message.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">By default, the REST message uses the endpoint specified in the REST message record. Use\\n this method to override this default. You must call this method when using the <a class=\\\"xref\\\" href=\\\"#r_RMV2-RESTMessageV2\\\" title=\\\"Instantiates an empty RESTMessageV2 object.\\\">RESTMessageV2 - RESTMessageV2()</a> constructor with no parameters.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 29. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__1\\\">endpoint</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEndpoint_String_endpoint__table_vy2_525_jq__entry__3\\\">The URL of the REST provider you want to interface with.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 30. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setEndpoint_String_endpoint__table_utf_cmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2();\\nsm.setEndpoint("http://web.service.endpoint");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setHttpMethod_String_method\\\" id=\\\"r_RMV2-setHttpMethod_String_method\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setHttpMethod_String_method\\\">RESTMessageV2 - setHttpMethod(String method)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the HTTP method this REST message performs, such as GET or PUT.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">You must set an HTTP method when using the <a class=\\\"xref\\\" href=\\\"#r_RMV2-RESTMessageV2\\\" title=\\\"Instantiates an empty RESTMessageV2 object.\\\">RESTMessageV2 - RESTMessageV2()</a> constructor with no parameters.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 31. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__1\\\">method</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpMethod_String_method__table_vy2_525_jq__entry__3\\\">HTTP method to perform.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 32. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpMethod_String_method__table_bqb_cmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2();\\nsm.setHttpMethod("post");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setHttpTimeout_N\\\" id=\\\"r_RMV2-setHttpTimeout_N\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setHttpTimeout_N\\\">RESTMessageV2 - setHttpTimeout(Number timeoutMs)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the amount of time the REST message waits for a response from the web service\\n provider before the request times out.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 33. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__1\\\">timeoutMs</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpTimeout_N__table_vy2_525_jq__entry__3\\\">Amount of time in milliseconds before the call to the REST provider times out.<div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This value sets a timeout on the socket and only times out if the socket\\n does not receive data within the specified time. For environments in which\\n responses are streamed, it's possible that connections last much longer than the\\n timeout value.</div></div></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 34. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setHttpTimeout_N__table_tcy_bmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">To use the following example, replace <var class=\\\"keyword varname\\\"><REST_message_record></var> with the\\n name of the REST message record from your instance.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Might throw exception if message doesn't exist or not visible due to scope.\\nvar sm = new sn_ws.RESTMessageV2("<REST_message_record>", "get");\\nsm.setHttpTimeout(6000);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RMV2-setLogLevel_S\\\" id=\\\"RMV2-setLogLevel_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RMV2-setLogLevel_S\\\">RESTMessageV2 - setLogLevel(String level)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the log level for this message and the corresponding response.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Setting a log level using the RESTMessageV2 API overrides the log level configured on the\\n REST message record. This log level may not apply if the endpoint domain is excluded, or if\\n the property <span class=\\\"keyword parmname\\\">glide.outbound_http_log.override</span> is true. To view outbound\\n web service logs, navigate to <span class=\\\"ph menucascade\\\"><span class=\\\"ph uicontrol\\\">System Logs</span><abbr> > </abbr><span class=\\\"ph uicontrol\\\">Outbound HTTP Requests</span></span>.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RMV2-setLogLevel_S__table_jsf_y55_rw\\\"><caption><span class=\\\"table--title-label\\\">Table 35. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__1\\\">level</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RMV2-setLogLevel_S__table_jsf_y55_rw__entry__3\\\">The log level. Valid values are basic, elevated, and all.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RMV2-setLogLevel_S__table_ksf_y55_rw\\\"><caption><span class=\\\"table--title-label\\\">Table 36. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RMV2-setLogLevel_S__table_ksf_y55_rw__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var rm = new sn_ws.RESTMessageV2();\\nrm.setLogLevel('all');</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setMIDServer_S\\\" id=\\\"r_RMV2-setMIDServer_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setMIDServer_S\\\">RESTMessageV2 - setMIDServer(String midServer)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Configures the REST message to communicate through a <span class=\\\"ph\\\">MID Server</span>.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setMIDServer_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 37. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__1\\\">midServer</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMIDServer_S__table_vy2_525_jq__entry__3\\\">Name of the <span class=\\\"ph\\\">MID Server</span> to use. Your instance must have an active\\n <span class=\\\"ph\\\">MID Server</span> with the specified name.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setMIDServer_S__table_el5_bmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 38. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMIDServer_S__table_el5_bmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setMIDServer("mid_server_name");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setMutualAuth_S\\\" id=\\\"r_RMV2-setMutualAuth_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setMutualAuth_S\\\">RESTMessageV2 - setMutualAuth(String profileName)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the mutual authentication protocol profile for the REST message.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Setting a protocol profile using this method overrides the protocol profile selected for\\n the REST message record.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setMutualAuth_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 39. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__1\\\">profileName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMutualAuth_S__table_vy2_525_jq__entry__3\\\">The <span class=\\\"ph uicontrol\\\">Name</span> of the protocol profile to use for mutual\\n authentication.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 40. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setMutualAuth_S__table_r1r_bmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setMutualAuth("mutual_auth_profile_name");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setQueryParameter_S_S\\\" id=\\\"r_RMV2-setQueryParameter_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setQueryParameter_S_S\\\">RESTMessageV2 - setQueryParameter(String name, String value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Appends a parameter to the end of the request URL with the form name=value.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">For example, the code\\n setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory"); appends\\n the text sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory to the request URL.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 41. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__3\\\">Name of the URL parameter to pass.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_vy2_525_jq__entry__3\\\">Value to assign the URL parameter.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 42. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setQueryParameter_S_S__table_cnm_bmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2();\\n//Set up message, including endpoint and authentication\\nsm.setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setRequestBody_String_body\\\" id=\\\"r_RMV2-setRequestBody_String_body\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setRequestBody_String_body\\\">RESTMessageV2 - setRequestBody(String body)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the body content to send to the web service provider when using PUT or POST HTTP\\n methods.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">When you set the body content using this method, variables in the body are not substituted\\n for parameters from the REST message function record. You must explicitly define all values\\n within the REST message body.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 43. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__1\\\">body</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestBody_String_body__table_vy2_525_jq__entry__3\\\">Request body to send.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 44. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestBody_String_body__table_gft_1mh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Update user","post"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar body = "<Message body content>";\\nsm.setRequestBody(body);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setReqBodyFromAttachment_S\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setReqBodyFromAttachment_S\\\">RESTMessageV2 - setRequestBodyFromAttachment(String attachmentSysId)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the request body using an existing attachment record.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__p_RMv2_MID_roles_req\\\">When you use this function with a REST message that is sent\\n through a <span class=\\\"ph\\\">MID Server</span>, the <span class=\\\"ph\\\">MID Server</span> user must have any roles\\n required to read attachment records.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s\\\"><caption><span class=\\\"table--title-label\\\">Table 45. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__1\\\">attachmentSysId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setReqBodyFromAttachment_S__table_kn2_bp3_5s__entry__3\\\">Sys_id of the Attachment [sys_attachment] record you want to send in this REST\\n message.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s\\\"><caption><span class=\\\"table--title-label\\\">Table 46. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setReqBodyFromAttachment_S__table_ln2_bp3_5s__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">(function sampleRESTMessageV2() {\\n try {\\n var request = new sn_ws.RESTMessageV2();\\n request.setHttpMethod('post');\\n request.setEndpoint('<web service endpoint URL>');\\n request.setRequestBodyFromAttachment('<attachment sys_id>');\\n \\n var response = request.execute();\\n var httpResponseStatus = response.getStatusCode();\\n \\n gs.info("http response status_code: " + httpResponseStatus); \\n }\\n catch (ex) {\\n var message = ex.getMessage();\\n gs.info(message);\\n }\\n})();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setRequestHeader_S_S\\\" id=\\\"r_RMV2-setRequestHeader_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setRequestHeader_S_S\\\">RESTMessageV2 - setRequestHeader(String name, String value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets an HTTP header in the REST message to the specified value.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 47. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__3\\\">Name of the header.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_vy2_525_jq__entry__3\\\">Value to assign to the specified header.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 48. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setRequestHeader_S_S__table_ryx_1mh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setRequestHeader("Accept","Application/json");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMv2-setRequestorProfile_S_S\\\" id=\\\"r_RMv2-setRequestorProfile_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMv2-setRequestorProfile_S_S\\\">RESTMessageV2 - setRequestorProfile(String requestorContext, String requestorId)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Overrides the default requestor profile for the REST message in order to retrieve an\\n OAuth access token associated with a different requestor.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">This method applies only to REST messages configured to use OAuth 2.0 authentication. This\\n method is optional and is unnecessary in most configurations.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt\\\"><caption><span class=\\\"table--title-label\\\">Table 49. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__1\\\">requestorContext</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__3\\\"></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__1\\\">requestorId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_c4t_2my_lt__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt\\\"><caption><span class=\\\"table--title-label\\\">Table 50. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMv2-setRequestorProfile_S_S__table_d4t_2my_lt__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setStringParameter_S_S\\\" id=\\\"r_RMV2-setStringParameter_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setStringParameter_S_S\\\">RESTMessageV2 - setStringParameter(String name, String value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets a REST message function variable with the specified name from the REST message\\n record to the specified value.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">XML reserved characters in the value are converted to the equivalent escaped characters.\\n Use <span class=\\\"keyword apiname\\\">setStringParameterNoEscape</span> to set a variable without escaping XML\\n reserved characters.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 51. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__3\\\">Name of the REST message variable. This parameter must be defined in the REST\\n message record before you can assign a value to it.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_vy2_525_jq__entry__3\\\">Value to assign the variable.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 52. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStringParameter_S_S__table_c1n_zlh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setStringParameter("s","NOW");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RMV2-setStrParamNoEscape_S_S\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RMV2-setStrParamNoEscape_S_S\\\">RESTMessageV2 - setStringParameterNoEscape(String name, String value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets a REST message function variable with the specified name from the REST message\\n record to the specified value.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">This method is equivalent to <span class=\\\"keyword apiname\\\">setStringParameter</span> but does not escape XML\\n reserved characters.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 53. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__3\\\">Name of the REST message variable. This parameter must be defined in the REST\\n message record before you can assign a value to it.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_vy2_525_jq__entry__3\\\">Value to assign the variable.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 54. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RMV2-setStrParamNoEscape_S_S__table_yrh_zlh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, replace <var class=\\\"keyword varname\\\">REST_message_record</var> with the name of\\n the REST message record from your instance.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nsm.setStringParameterNoEscape("s","NOW");</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RESTMessageV2 - Scoped, Global\n\nThe RESTMessageV2 API allows you to send outbound REST messages using\nJavaScript.\n\nUse the RESTResponseV2 API to manage the response returned by the REST provider.\n\nThe User-Agent value is \"ServiceNow/1.0\". To change this, add the glide.http.user.agent system\nproperty in the System Properties [sys\\_properties] table.\n\nThis API runs in the `sn_ws` namespace.\n\n## RESTMessageV2 - disableForcedVariableSubstitution()\n\nDisables forced variable substitution in outbound REST messages.\n\nNote: Use of curly brackets or dollar signs in your request may inadvertently return a truncated output. If your request erroneously truncates the response or splits the response onto new lines, refer to this Community article for a potential solution.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\");\nsm.disableForcedVariableSubstitution();\nvar response = sm.execute();\n```\n\n## RESTMessageV2 - execute()\n\nSends the REST message to the endpoint.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| RESTResponse | The response returned by the REST provider. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n```\n\n## RESTMessageV2 - executeAsync()\n\nSends the REST message to the endpoint asynchronously. The instance does not wait for a\nresponse from the web service provider when making asynchronous calls.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| RESTResponse | The response returned by the REST provider. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance. When using `executeAsync`,\nconsider processing the response body in a separate business rule to take advantage of the\nasynchronous call.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.executeAsync(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\n```\n\n## RESTMessageV2 - getEndpoint()\n\nGets the URL of the endpoint for the REST message.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| String | The URL of the REST web service provider. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar endpoint = sm.getEndpoint();\n```\n\n## RESTMessageV2 - getRequestBody()\n\nGets the content of the REST message body.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | the REST message body. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar body = sm.getRequestBody();\n```\n\n## RESTMessageV2 - getRequestHeader(String headerName)\n\nGets the value for an HTTP header specified in the REST message.\n\nBy default, this method cannot return the value for a header set automatically by the\nsystem. To grant this method access to all headers, set the property glide.http.log\\_debug to\ntrue.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| headerName | String | Request header you want to get the value for. |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | The value of the specified header. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar header = sm.getRequestHeader(\"Accept\");\n```\n\n## RESTMessageV2 - getRequestHeaders()\n\nGets HTTP headers that were set by the REST client and the associated\nvalues.\n\nThis method does not return headers set automatically by the system. To configure this\nmethod to return all headers, set the property glide.http.log\\_debug to true.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | An Object that maps the name of each header to the associated value. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar headers = sm.getRequestHeaders();\n```\n\n## RESTMessageV2 - RESTMessageV2()\n\nInstantiates an empty RESTMessageV2 object.\n\nWhen using an object instantiated this way, you must manually specify an HTTP method and\nendpoint.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\n```\n\n## RESTMessageV2 - RESTMessageV2(String name, String methodName)\n\nInstantiates a RESTMessageV2 object using information from a REST message\nrecord.\n\nYou must have a REST message record defined before you can use this constructor.\n\nTable 16. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | The name of the REST message record. |\n| methodName | String | The name of the HTTP method to use, such as GET/get or PUT/put - case insensitive. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\n```\n\n## RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName)\n\nConfigures the REST message to save the returned response body as an attachment\nrecord.\n\nWhen you use this function with a REST message that is sent through a MID server, the MID server user must have any roles required to read and write attachment records, as well as any roles required to read and write records on\nthe table specified in the tableName parameter.\n\nThe response body does not need to be a binary file to be saved as an attachment. Response bodies using text formats, such as JSON or XML can also be saved. If the instance fails to save the attachment, call\ngetErrorMessage() on the related RESTResponseV2 object for error details.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableName | String | Specify the table that contains the record you want to attach the saved file to. |\n| recordSysId | String | Specify the sys\\_id of the record you want to attach the saved file to. |\n| fileName | String | Specify the file name to give to the saved file. |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\n(function sampleRESTMessageV2() {\n try{\n var request = new sn_ws.RESTMessageV2(); \n request.setHttpMethod('get');\n\n var attachment_sys_id = '<attachment_record_sys_id>', \n tablename = 'incident',\n recordSysId = '<incident_sys_id>', \n response, \n httpResponseStatus, \n filename ='<filename>';\n\n //endpoint - ServiceNow REST Attachment API \n request.setEndpoint('https://<instance_name>.service-now.com/api/now/attachment/' + attachment_sys_id +'/file'); \n request.setBasicAuth('<username>', '<password>');\n\n //RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName) \n request.saveResponseBodyAsAttachment(tablename, recordSysId, filename); \n\n response = request.execute(); \n httpResponseStatus = response.getStatusCode(); \n \n gs.info(\" http response status_code: \" + httpResponseStatus); \n }\n catch(ex){\n var message = ex.getMessage(); \n gs.info(message); \n }\n})();\n```\n\n## RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName, String encryptContext)\n\nConfigures the REST message to save the returned response body as an encrypted\nattachment record.\n\nWhen you use this function with a REST message that is sent through a MID server, the MID server user must have any roles required to read and write attachment records, as well as any roles required to read and write records on\nthe table specified in the tableName parameter.\n\nThe response body does not need to be a binary file to be saved as an attachment. Response bodies using text formats, such as JSON or XML can also be saved. If the instance fails to save the attachment, call\ngetErrorMessage() on the related RESTResponseV2 object for error details.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableName | String | Specify the table that contains the record you want to attach the saved file to. |\n| recordSysId | String | Specify the sys\\_id of the record you want to attach the saved file to. |\n| fileName | String | Specify the file name to give to the saved file. |\n| encryptContext | String | Specify the sys\\_id of an encryption context. The saved file is encrypted using this context. |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## RESTMessageV2 - setAuthenticationProfile(String type, String profileId)\n\nSets the credentials for the REST message using an existing basic auth or OAuth 2.0\nprofile.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| type | String | The type of authentication profile to use. Valid values are 'basic' to use basic authentication, or 'oauth2' to use OAuth 2.0. |\n| profileId | String | The sys\\_id of an authentication profile record. When using basic auth, specify the sys\\_id of a Basic Auth Configuration [sys\\_auth\\_profile\\_basic] record. When using OAuth 2.0, specify the sys\\_id of a OAuth Entity Profile [oauth\\_entity\\_profile] record. |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm = new sn_ws.RESTMessageV2(\"<REST_message_record>\", \"get\"); \n\n //set auth profile to an OAuth 2.0 profile record.\n\tsm.setAuthenticationProfile('oauth2', '1234adsf123212131123qasdsf'); \n\n\tsm.setStringParameter(\"symbol\", \"NOW\");\n\tsm.setStringParameterNoEscape(\"xml_data\",\"<data>test</data>\");\n\n //In milliseconds. Wait at most 10 seconds for response from http request.\n\tsm.setHttpTimeout(10000); \n //Might throw exception if http connection timed out or some issue \n //with sending request itself because of encryption/decryption of password.\n\tresponse = sm.execute();\t\n responseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\n```\n\n## RESTMessageV2 - setBasicAuth(String userName, String userPass)\n\nSets basic authentication headers for the REST message.\n\nSetting security values using this method overrides basic authentication values defined for\nthe REST message record.\n\nTable 23. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| userName | String | Username you want to use to authenticate the REST message. |\n| userPass | String | Password for the specified user. |\n\nTable 24. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setBasicAuth(\"username\",\"password\");\n```\n\n## RESTMessageV2 - setEccCorrelator(String correlator)\n\nAssociates outbound requests and the resulting response record in the ECC queue. This\nmethod only applies to REST messages sent through a MID Server.\n\nThe correlator provided populates the Agent correlator field on the\nECC queue record for the response. Provide a unique correlator for each outbound request to\nassociate the correct results in the ECC queue with the request when designing asynchronous\nautomation through a MID Server.\n\nTable 25. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| correlator | String | Unique identifier |\n\nTable 26. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setEccCorrelator(\"unique_identifier\");\n```\n\n## RESTMessageV2 - setEccParameter(String name, String value)\n\nOverrides a value from the database by writing to the REST message payload. This method\nonly applies to REST messages sent through a MID Server.\n\nUse this method when a value from the REST message in the database is invalid, such as when\nthe endpoint URL is longer than the maximum REST endpoint field length. You can set only the\nendpoint URL using this method by passing source as the name parameter.\n\nTable 27. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | The name of the parameter, such as source. |\n| value | String | The value to assign to the specified parameter. |\n\nTable 28. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setEccParameter(\"source\",\"http://very.long.endpoint.url\");\n```\n\n## RESTMessageV2 - setEndpoint(String endpoint)\n\nSets the endpoint for the REST message.\n\nBy default, the REST message uses the endpoint specified in the REST message record. Use\nthis method to override this default. You must call this method when using the RESTMessageV2 - RESTMessageV2() constructor with no parameters.\n\nTable 29. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| endpoint | String | The URL of the REST provider you want to interface with. |\n\nTable 30. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\nsm.setEndpoint(\"http://web.service.endpoint\");\n```\n\n## RESTMessageV2 - setHttpMethod(String method)\n\nSets the HTTP method this REST message performs, such as GET or PUT.\n\nYou must set an HTTP method when using the RESTMessageV2 - RESTMessageV2() constructor with no parameters.\n\nTable 31. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| method | String | HTTP method to perform. |\n\nTable 32. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\nsm.setHttpMethod(\"post\");\n```\n\n## RESTMessageV2 - setHttpTimeout(Number timeoutMs)\n\nSets the amount of time the REST message waits for a response from the web service\nprovider before the request times out.\n\nTable 33. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| timeoutMs | Number | Amount of time in milliseconds before the call to the REST provider times out.Note: This value sets a timeout on the socket and only times out if the socket does not receive data within the specified time. For environments in which responses are streamed, it's possible that connections last much longer than the timeout value. |\n\nTable 34. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nTo use the following example, replace <REST\\_message\\_record> with the\nname of the REST message record from your instance.\n\n```None\n// Might throw exception if message doesn't exist or not visible due to scope.\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\", \"get\");\nsm.setHttpTimeout(6000);\n```\n\n## RESTMessageV2 - setLogLevel(String level)\n\nSets the log level for this message and the corresponding response.\n\nSetting a log level using the RESTMessageV2 API overrides the log level configured on the\nREST message record. This log level may not apply if the endpoint domain is excluded, or if\nthe property glide.outbound\\_http\\_log.override is true. To view outbound\nweb service logs, navigate to System Logs > Outbound HTTP Requests.\n\nTable 35. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| level | String | The log level. Valid values are basic, elevated, and all. |\n\nTable 36. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar rm = new sn_ws.RESTMessageV2();\nrm.setLogLevel('all');\n```\n\n## RESTMessageV2 - setMIDServer(String midServer)\n\nConfigures the REST message to communicate through a MID Server.\n\nTable 37. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| midServer | String | Name of the MID Server to use. Your instance must have an active MID Server with the specified name. |\n\nTable 38. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setMIDServer(\"mid_server_name\");\n```\n\n## RESTMessageV2 - setMutualAuth(String profileName)\n\nSets the mutual authentication protocol profile for the REST message.\n\nSetting a protocol profile using this method overrides the protocol profile selected for\nthe REST message record.\n\nTable 39. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| profileName | String | The Name of the protocol profile to use for mutual authentication. |\n\nTable 40. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setMutualAuth(\"mutual_auth_profile_name\");\n```\n\n## RESTMessageV2 - setQueryParameter(String name, String value)\n\nAppends a parameter to the end of the request URL with the form name=value.\n\nFor example, the code\nsetQueryParameter(\"sysparm\\_query\",\"active=true^ORDERBYnumber^ORDERBYDESCcategory\"); appends\nthe text sysparm\\_query=active=true^ORDERBYnumber^ORDERBYDESCcategory to the request URL.\n\nTable 41. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the URL parameter to pass. |\n| value | String | Value to assign the URL parameter. |\n\nTable 42. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\n//Set up message, including endpoint and authentication\nsm.setQueryParameter(\"sysparm_query\",\"active=true^ORDERBYnumber^ORDERBYDESCcategory\");\n```\n\n## RESTMessageV2 - setRequestBody(String body)\n\nSets the body content to send to the web service provider when using PUT or POST HTTP\nmethods.\n\nWhen you set the body content using this method, variables in the body are not substituted\nfor parameters from the REST message function record. You must explicitly define all values\nwithin the REST message body.\n\nTable 43. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| body | String | Request body to send. |\n\nTable 44. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Update user\",\"post\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar body = \"<Message body content>\";\nsm.setRequestBody(body);\n```\n\n## RESTMessageV2 - setRequestBodyFromAttachment(String attachmentSysId)\n\nSets the request body using an existing attachment record.\n\nWhen you use this function with a REST message that is sent\nthrough a MID Server, the MID Server user must have any roles\nrequired to read attachment records.\n\nTable 45. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| attachmentSysId | String | Sys\\_id of the Attachment [sys\\_attachment] record you want to send in this REST message. |\n\nTable 46. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\n(function sampleRESTMessageV2() {\n try {\n var request = new sn_ws.RESTMessageV2();\n request.setHttpMethod('post');\n request.setEndpoint('<web service endpoint URL>');\n request.setRequestBodyFromAttachment('<attachment sys_id>');\n \n var response = request.execute();\n var httpResponseStatus = response.getStatusCode();\n \n gs.info(\"http response status_code: \" + httpResponseStatus); \n }\n catch (ex) {\n var message = ex.getMessage();\n gs.info(message);\n }\n})();\n```\n\n## RESTMessageV2 - setRequestHeader(String name, String value)\n\nSets an HTTP header in the REST message to the specified value.\n\nTable 47. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the header. |\n| value | String | Value to assign to the specified header. |\n\nTable 48. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setRequestHeader(\"Accept\",\"Application/json\");\n```\n\n## RESTMessageV2 - setRequestorProfile(String requestorContext, String requestorId)\n\nOverrides the default requestor profile for the REST message in order to retrieve an\nOAuth access token associated with a different requestor.\n\nThis method applies only to REST messages configured to use OAuth 2.0 authentication. This\nmethod is optional and is unnecessary in most configurations.\n\nTable 49. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| requestorContext | String | |\n| requestorId | String | |\n\nTable 50. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## RESTMessageV2 - setStringParameter(String name, String value)\n\nSets a REST message function variable with the specified name from the REST message\nrecord to the specified value.\n\nXML reserved characters in the value are converted to the equivalent escaped characters.\nUse setStringParameterNoEscape to set a variable without escaping XML\nreserved characters.\n\nTable 51. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the REST message variable. This parameter must be defined in the REST message record before you can assign a value to it. |\n| value | String | Value to assign the variable. |\n\nTable 52. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setStringParameter(\"s\",\"NOW\");\n```\n\n## RESTMessageV2 - setStringParameterNoEscape(String name, String value)\n\nSets a REST message function variable with the specified name from the REST message\nrecord to the specified value.\n\nThis method is equivalent to setStringParameter but does not escape XML\nreserved characters.\n\nTable 53. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the REST message variable. This parameter must be defined in the REST message record before you can assign a value to it. |\n| value | String | Value to assign the variable. |\n\nTable 54. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setStringParameterNoEscape(\"s\",\"NOW\");\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RESTMessageV2 - Scoped, Global\ndescription: The RESTMessageV2 API allows you to send outbound REST messages using\n JavaScript.\nkeywords:\n- RESTMessageV2\n- disableForcedVariableSubstitution()\n- RESTMessagev2\n- execute()\n- getEndpoint()\n- getRequestBody()\n- getRequestHeader(String headerName)\n- getRequestHeaders()\n- RESTMessageV2()\n- RESTMessageV2(String name\n- String methodName)\n- saveResponseBodyAsAttachment(String tableName\n- String recordSysId\n- String fileName\n- String encryptContext)\n- setAuthenticationProfile(String type\n- String profileId)\n- setBasicAuth(String userName\n- String userPass)\n- setEccCorrelator(String correlator)\n- setEccParameter(String name\n- String value)\n- setEndpoint(String endpoint)\n- setHttpMethod(String method)\n- setHttpTimeout(Number timeoutMs)\n- setLogLevel(String level)\n- setMIDServer(String midServer)\n- setMutualAuth(String profileName)\n- setQueryParameter(String name\n- String value)\n- setRequestBody(String body)\n- setRequestBodyFromAttachment\n- setRequestHeader(String name\n- String value)\n- setRequestorProfile(String requestorContext\n- String requestorId)\n- setStringParameter(String name\n- String value)\n- setStringParameterNoEscape(String name\n- String value)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RESTMessageV2 - Scoped, Global\n\nThe RESTMessageV2 API allows you to send outbound REST messages using\nJavaScript.\n\nUse the RESTResponseV2 API to manage the response returned by the REST provider.\n\nThe User-Agent value is \"ServiceNow/1.0\". To change this, add the glide.http.user.agent system\nproperty in the System Properties [sys\\_properties] table.\n\nThis API runs in the `sn_ws` namespace.\n\n## RESTMessageV2 - disableForcedVariableSubstitution()\n\nDisables forced variable substitution in outbound REST messages.\n\nNote: Use of curly brackets or dollar signs in your request may inadvertently return a truncated output. If your request erroneously truncates the response or splits the response onto new lines, refer to this Community article for a potential solution.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\");\nsm.disableForcedVariableSubstitution();\nvar response = sm.execute();\n```\n\n## RESTMessageV2 - execute()\n\nSends the REST message to the endpoint.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| RESTResponse | The response returned by the REST provider. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n```\n\n## RESTMessageV2 - executeAsync()\n\nSends the REST message to the endpoint asynchronously. The instance does not wait for a\nresponse from the web service provider when making asynchronous calls.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| RESTResponse | The response returned by the REST provider. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance. When using `executeAsync`,\nconsider processing the response body in a separate business rule to take advantage of the\nasynchronous call.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.executeAsync(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\n```\n\n## RESTMessageV2 - getEndpoint()\n\nGets the URL of the endpoint for the REST message.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| String | The URL of the REST web service provider. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar endpoint = sm.getEndpoint();\n```\n\n## RESTMessageV2 - getRequestBody()\n\nGets the content of the REST message body.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | the REST message body. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar body = sm.getRequestBody();\n```\n\n## RESTMessageV2 - getRequestHeader(String headerName)\n\nGets the value for an HTTP header specified in the REST message.\n\nBy default, this method cannot return the value for a header set automatically by the\nsystem. To grant this method access to all headers, set the property glide.http.log\\_debug to\ntrue.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| headerName | String | Request header you want to get the value for. |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | The value of the specified header. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar header = sm.getRequestHeader(\"Accept\");\n```\n\n## RESTMessageV2 - getRequestHeaders()\n\nGets HTTP headers that were set by the REST client and the associated\nvalues.\n\nThis method does not return headers set automatically by the system. To configure this\nmethod to return all headers, set the property glide.http.log\\_debug to true.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | An Object that maps the name of each header to the associated value. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar headers = sm.getRequestHeaders();\n```\n\n## RESTMessageV2 - RESTMessageV2()\n\nInstantiates an empty RESTMessageV2 object.\n\nWhen using an object instantiated this way, you must manually specify an HTTP method and\nendpoint.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\n```\n\n## RESTMessageV2 - RESTMessageV2(String name, String methodName)\n\nInstantiates a RESTMessageV2 object using information from a REST message\nrecord.\n\nYou must have a REST message record defined before you can use this constructor.\n\nTable 16. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | The name of the REST message record. |\n| methodName | String | The name of the HTTP method to use, such as GET/get or PUT/put - case insensitive. |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\n```\n\n## RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName)\n\nConfigures the REST message to save the returned response body as an attachment\nrecord.\n\nWhen you use this function with a REST message that is sent through a MID server, the MID server user must have any roles required to read and write attachment records, as well as any roles required to read and write records on\nthe table specified in the tableName parameter.\n\nThe response body does not need to be a binary file to be saved as an attachment. Response bodies using text formats, such as JSON or XML can also be saved. If the instance fails to save the attachment, call\ngetErrorMessage() on the related RESTResponseV2 object for error details.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableName | String | Specify the table that contains the record you want to attach the saved file to. |\n| recordSysId | String | Specify the sys\\_id of the record you want to attach the saved file to. |\n| fileName | String | Specify the file name to give to the saved file. |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\n(function sampleRESTMessageV2() {\n try{\n var request = new sn_ws.RESTMessageV2(); \n request.setHttpMethod('get');\n\n var attachment_sys_id = '<attachment_record_sys_id>', \n tablename = 'incident',\n recordSysId = '<incident_sys_id>', \n response, \n httpResponseStatus, \n filename ='<filename>';\n\n //endpoint - ServiceNow REST Attachment API \n request.setEndpoint('https://<instance_name>.service-now.com/api/now/attachment/' + attachment_sys_id +'/file'); \n request.setBasicAuth('<username>', '<password>');\n\n //RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName) \n request.saveResponseBodyAsAttachment(tablename, recordSysId, filename); \n\n response = request.execute(); \n httpResponseStatus = response.getStatusCode(); \n \n gs.info(\" http response status_code: \" + httpResponseStatus); \n }\n catch(ex){\n var message = ex.getMessage(); \n gs.info(message); \n }\n})();\n```\n\n## RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName, String encryptContext)\n\nConfigures the REST message to save the returned response body as an encrypted\nattachment record.\n\nWhen you use this function with a REST message that is sent through a MID server, the MID server user must have any roles required to read and write attachment records, as well as any roles required to read and write records on\nthe table specified in the tableName parameter.\n\nThe response body does not need to be a binary file to be saved as an attachment. Response bodies using text formats, such as JSON or XML can also be saved. If the instance fails to save the attachment, call\ngetErrorMessage() on the related RESTResponseV2 object for error details.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableName | String | Specify the table that contains the record you want to attach the saved file to. |\n| recordSysId | String | Specify the sys\\_id of the record you want to attach the saved file to. |\n| fileName | String | Specify the file name to give to the saved file. |\n| encryptContext | String | Specify the sys\\_id of an encryption context. The saved file is encrypted using this context. |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## RESTMessageV2 - setAuthenticationProfile(String type, String profileId)\n\nSets the credentials for the REST message using an existing basic auth or OAuth 2.0\nprofile.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| type | String | The type of authentication profile to use. Valid values are 'basic' to use basic authentication, or 'oauth2' to use OAuth 2.0. |\n| profileId | String | The sys\\_id of an authentication profile record. When using basic auth, specify the sys\\_id of a Basic Auth Configuration [sys\\_auth\\_profile\\_basic] record. When using OAuth 2.0, specify the sys\\_id of a OAuth Entity Profile [oauth\\_entity\\_profile] record. |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm = new sn_ws.RESTMessageV2(\"<REST_message_record>\", \"get\"); \n\n //set auth profile to an OAuth 2.0 profile record.\n\tsm.setAuthenticationProfile('oauth2', '1234adsf123212131123qasdsf'); \n\n\tsm.setStringParameter(\"symbol\", \"NOW\");\n\tsm.setStringParameterNoEscape(\"xml_data\",\"<data>test</data>\");\n\n //In milliseconds. Wait at most 10 seconds for response from http request.\n\tsm.setHttpTimeout(10000); \n //Might throw exception if http connection timed out or some issue \n //with sending request itself because of encryption/decryption of password.\n\tresponse = sm.execute();\t\n responseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\n```\n\n## RESTMessageV2 - setBasicAuth(String userName, String userPass)\n\nSets basic authentication headers for the REST message.\n\nSetting security values using this method overrides basic authentication values defined for\nthe REST message record.\n\nTable 23. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| userName | String | Username you want to use to authenticate the REST message. |\n| userPass | String | Password for the specified user. |\n\nTable 24. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setBasicAuth(\"username\",\"password\");\n```\n\n## RESTMessageV2 - setEccCorrelator(String correlator)\n\nAssociates outbound requests and the resulting response record in the ECC queue. This\nmethod only applies to REST messages sent through a MID Server.\n\nThe correlator provided populates the Agent correlator field on the\nECC queue record for the response. Provide a unique correlator for each outbound request to\nassociate the correct results in the ECC queue with the request when designing asynchronous\nautomation through a MID Server.\n\nTable 25. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| correlator | String | Unique identifier |\n\nTable 26. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setEccCorrelator(\"unique_identifier\");\n```\n\n## RESTMessageV2 - setEccParameter(String name, String value)\n\nOverrides a value from the database by writing to the REST message payload. This method\nonly applies to REST messages sent through a MID Server.\n\nUse this method when a value from the REST message in the database is invalid, such as when\nthe endpoint URL is longer than the maximum REST endpoint field length. You can set only the\nendpoint URL using this method by passing source as the name parameter.\n\nTable 27. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | The name of the parameter, such as source. |\n| value | String | The value to assign to the specified parameter. |\n\nTable 28. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setEccParameter(\"source\",\"http://very.long.endpoint.url\");\n```\n\n## RESTMessageV2 - setEndpoint(String endpoint)\n\nSets the endpoint for the REST message.\n\nBy default, the REST message uses the endpoint specified in the REST message record. Use\nthis method to override this default. You must call this method when using the RESTMessageV2 - RESTMessageV2() constructor with no parameters.\n\nTable 29. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| endpoint | String | The URL of the REST provider you want to interface with. |\n\nTable 30. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\nsm.setEndpoint(\"http://web.service.endpoint\");\n```\n\n## RESTMessageV2 - setHttpMethod(String method)\n\nSets the HTTP method this REST message performs, such as GET or PUT.\n\nYou must set an HTTP method when using the RESTMessageV2 - RESTMessageV2() constructor with no parameters.\n\nTable 31. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| method | String | HTTP method to perform. |\n\nTable 32. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\nsm.setHttpMethod(\"post\");\n```\n\n## RESTMessageV2 - setHttpTimeout(Number timeoutMs)\n\nSets the amount of time the REST message waits for a response from the web service\nprovider before the request times out.\n\nTable 33. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| timeoutMs | Number | Amount of time in milliseconds before the call to the REST provider times out.Note: This value sets a timeout on the socket and only times out if the socket does not receive data within the specified time. For environments in which responses are streamed, it's possible that connections last much longer than the timeout value. |\n\nTable 34. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nTo use the following example, replace <REST\\_message\\_record> with the\nname of the REST message record from your instance.\n\n```None\n// Might throw exception if message doesn't exist or not visible due to scope.\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\", \"get\");\nsm.setHttpTimeout(6000);\n```\n\n## RESTMessageV2 - setLogLevel(String level)\n\nSets the log level for this message and the corresponding response.\n\nSetting a log level using the RESTMessageV2 API overrides the log level configured on the\nREST message record. This log level may not apply if the endpoint domain is excluded, or if\nthe property glide.outbound\\_http\\_log.override is true. To view outbound\nweb service logs, navigate to System Logs > Outbound HTTP Requests.\n\nTable 35. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| level | String | The log level. Valid values are basic, elevated, and all. |\n\nTable 36. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar rm = new sn_ws.RESTMessageV2();\nrm.setLogLevel('all');\n```\n\n## RESTMessageV2 - setMIDServer(String midServer)\n\nConfigures the REST message to communicate through a MID Server.\n\nTable 37. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| midServer | String | Name of the MID Server to use. Your instance must have an active MID Server with the specified name. |\n\nTable 38. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setMIDServer(\"mid_server_name\");\n```\n\n## RESTMessageV2 - setMutualAuth(String profileName)\n\nSets the mutual authentication protocol profile for the REST message.\n\nSetting a protocol profile using this method overrides the protocol profile selected for\nthe REST message record.\n\nTable 39. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| profileName | String | The Name of the protocol profile to use for mutual authentication. |\n\nTable 40. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setMutualAuth(\"mutual_auth_profile_name\");\n```\n\n## RESTMessageV2 - setQueryParameter(String name, String value)\n\nAppends a parameter to the end of the request URL with the form name=value.\n\nFor example, the code\nsetQueryParameter(\"sysparm\\_query\",\"active=true^ORDERBYnumber^ORDERBYDESCcategory\"); appends\nthe text sysparm\\_query=active=true^ORDERBYnumber^ORDERBYDESCcategory to the request URL.\n\nTable 41. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the URL parameter to pass. |\n| value | String | Value to assign the URL parameter. |\n\nTable 42. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2();\n//Set up message, including endpoint and authentication\nsm.setQueryParameter(\"sysparm_query\",\"active=true^ORDERBYnumber^ORDERBYDESCcategory\");\n```\n\n## RESTMessageV2 - setRequestBody(String body)\n\nSets the body content to send to the web service provider when using PUT or POST HTTP\nmethods.\n\nWhen you set the body content using this method, variables in the body are not substituted\nfor parameters from the REST message function record. You must explicitly define all values\nwithin the REST message body.\n\nTable 43. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| body | String | Request body to send. |\n\nTable 44. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Update user\",\"post\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar body = \"<Message body content>\";\nsm.setRequestBody(body);\n```\n\n## RESTMessageV2 - setRequestBodyFromAttachment(String attachmentSysId)\n\nSets the request body using an existing attachment record.\n\nWhen you use this function with a REST message that is sent\nthrough a MID Server, the MID Server user must have any roles\nrequired to read attachment records.\n\nTable 45. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| attachmentSysId | String | Sys\\_id of the Attachment [sys\\_attachment] record you want to send in this REST message. |\n\nTable 46. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\n(function sampleRESTMessageV2() {\n try {\n var request = new sn_ws.RESTMessageV2();\n request.setHttpMethod('post');\n request.setEndpoint('<web service endpoint URL>');\n request.setRequestBodyFromAttachment('<attachment sys_id>');\n \n var response = request.execute();\n var httpResponseStatus = response.getStatusCode();\n \n gs.info(\"http response status_code: \" + httpResponseStatus); \n }\n catch (ex) {\n var message = ex.getMessage();\n gs.info(message);\n }\n})();\n```\n\n## RESTMessageV2 - setRequestHeader(String name, String value)\n\nSets an HTTP header in the REST message to the specified value.\n\nTable 47. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the header. |\n| value | String | Value to assign to the specified header. |\n\nTable 48. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setRequestHeader(\"Accept\",\"Application/json\");\n```\n\n## RESTMessageV2 - setRequestorProfile(String requestorContext, String requestorId)\n\nOverrides the default requestor profile for the REST message in order to retrieve an\nOAuth access token associated with a different requestor.\n\nThis method applies only to REST messages configured to use OAuth 2.0 authentication. This\nmethod is optional and is unnecessary in most configurations.\n\nTable 49. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| requestorContext | String | |\n| requestorId | String | |\n\nTable 50. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## RESTMessageV2 - setStringParameter(String name, String value)\n\nSets a REST message function variable with the specified name from the REST message\nrecord to the specified value.\n\nXML reserved characters in the value are converted to the equivalent escaped characters.\nUse setStringParameterNoEscape to set a variable without escaping XML\nreserved characters.\n\nTable 51. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the REST message variable. This parameter must be defined in the REST message record before you can assign a value to it. |\n| value | String | Value to assign the variable. |\n\nTable 52. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setStringParameter(\"s\",\"NOW\");\n```\n\n## RESTMessageV2 - setStringParameterNoEscape(String name, String value)\n\nSets a REST message function variable with the specified name from the REST message\nrecord to the specified value.\n\nThis method is equivalent to setStringParameter but does not escape XML\nreserved characters.\n\nTable 53. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the REST message variable. This parameter must be defined in the REST message record before you can assign a value to it. |\n| value | String | Value to assign the variable. |\n\nTable 54. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nIn the following example, replace REST\\_message\\_record with the name of\nthe REST message record from your instance.\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"<REST_message_record>\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nsm.setStringParameterNoEscape(\"s\",\"NOW\");\n```\n"}}},{"rowIdx":1988,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"Direct RESTMessageV2 example"},"description":{"kind":"string","value":"You can send an outbound REST message directly to the endpoint."},"keywords":{"kind":"list like","value":["RESTMessageV2","Example direct message"],"string":"[\n \"RESTMessageV2\",\n \"Example direct message\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API implementation","Web services","Outbound web services","Outbound REST web service","Scripting outbound REST"],"string":"[\n \"API implementation and reference\",\n \"API implementation\",\n \"Web services\",\n \"Outbound web services\",\n \"Outbound REST web service\",\n \"Scripting outbound REST\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body id=\"r_DirectRESTMessageV2Example\"><main role=\"main\"><article role=\"article\" class=\"dita\" id=\"r_DirectRESTMessageV2Example\" aria-labelledby=\"title_r_DirectRESTMessageV2Example\">\n <h1 class=\"title topictitle1\" id=\"title_r_DirectRESTMessageV2Example\">Direct RESTMessageV2 example</h1>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">You can send an outbound REST message directly to the endpoint.</p>\n <section class=\"section\">\n <p class=\"p\">In this example, the script sends a REST message requesting a stock quote and waits for a\n response. If there is no response from the web service provider, or if the specified REST\n message record is unavailable, the script throws an error, handled in this example by the\n try-catch block.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n\tsm = new sn_ws.RESTMessageV2("Yahoo Finance", "get"); // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm.setBasicAuth("admin","admin");\n\tsm.setStringParameter("symbol", "NOW");\n\tsm.setStringParameterNoEscape("xml_data","<data>test</data>");\n\tsm.setHttpTimeout(10000); //In milliseconds. Wait at most 10 seconds for response from http request.\n\n\tresponse = sm.execute();//Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\ngs.info("Request Body: " + requestBody);\ngs.info("Response: " + responseBody);\ngs.info("HTTP Status: " + status);</code></pre>\n </section>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API implementation\",\n \"topic_id\": \"build/applications/concept/api-implementation.html\"\n },\n {\n \"title\": \"Web services\",\n \"topic_id\": \"integrate/web-services/reference/r_AvailableWebServices.html\"\n },\n {\n \"title\": \"Outbound web services\",\n \"topic_id\": \"integrate/outbound-web-services/concept/outbound-web-services.html\"\n },\n {\n \"title\": \"Outbound REST web service\",\n \"topic_id\": \"integrate/outbound-rest/concept/c_OutboundRESTWebService.html\"\n },\n {\n \"title\": \"Scripting outbound REST\",\n \"topic_id\": \"integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation.html\\\">API implementation</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/web-services/reference/r_AvailableWebServices.html\\\">Web services</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-web-services/concept/outbound-web-services.html\\\">Outbound web services</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-rest/concept/c_OutboundRESTWebService.html\\\">Outbound REST web service</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\\\">Scripting outbound REST</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">Direct RESTMessageV2 example</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206651\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"OutboundRest\",\n \"navtitle\": \"Outbound REST Web Service\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > App development and low-code > Building applications > Outbound REST Web Service\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206651\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"r_DirectRESTMessageV2Example\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"RESTMessageV2,Example direct message\",\n \"DC.type\": \"reference\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"You can send an outbound REST message directly to the endpoint.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"RESTMessageV2, Example direct message\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": null,\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\",\n \"page_key\": 41206651,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 1340,\n \"img_count\": 0,\n \"read_time\": 1,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 171\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"Direct RESTMessageV2 example\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body id=\\\"r_DirectRESTMessageV2Example\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" id=\\\"r_DirectRESTMessageV2Example\\\" aria-labelledby=\\\"title_r_DirectRESTMessageV2Example\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_r_DirectRESTMessageV2Example\\\">Direct RESTMessageV2 example</h1>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">You can send an outbound REST message directly to the endpoint.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">In this example, the script sends a REST message requesting a stock quote and waits for a\\n response. If there is no response from the web service provider, or if the specified REST\\n message record is unavailable, the script throws an error, handled in this example by the\\n try-catch block.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var requestBody;\\nvar responseBody;\\nvar status;\\nvar sm;\\ntry{\\n\\tsm = new sn_ws.RESTMessageV2("Yahoo Finance", "get"); // Might throw exception if message doesn't exist or not visible due to scope.\\n\\tsm.setBasicAuth("admin","admin");\\n\\tsm.setStringParameter("symbol", "NOW");\\n\\tsm.setStringParameterNoEscape("xml_data","<data>test</data>");\\n\\tsm.setHttpTimeout(10000); //In milliseconds. Wait at most 10 seconds for response from http request.\\n\\n\\tresponse = sm.execute();//Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\\n\\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\\n\\tstatus = response.getStatusCode();\\n} catch(ex) {\\n\\tresponseBody = ex.getMessage();\\n\\tstatus = '500';\\n} finally {\\n\\trequestBody = sm ? sm.getRequestBody():null;\\n}\\ngs.info("Request Body: " + requestBody);\\ngs.info("Response: " + responseBody);\\ngs.info("HTTP Status: " + status);</code></pre>\\n </section>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Direct RESTMessageV2 example\n\nYou can send an outbound REST message directly to the endpoint.\n\nIn this example, the script sends a REST message requesting a stock quote and waits for a\nresponse. If there is no response from the web service provider, or if the specified REST\nmessage record is unavailable, the script throws an error, handled in this example by the\ntry-catch block.\n\n```None\nvar requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n\tsm = new sn_ws.RESTMessageV2(\"Yahoo Finance\", \"get\"); // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm.setBasicAuth(\"admin\",\"admin\");\n\tsm.setStringParameter(\"symbol\", \"NOW\");\n\tsm.setStringParameterNoEscape(\"xml_data\",\"<data>test</data>\");\n\tsm.setHttpTimeout(10000); //In milliseconds. Wait at most 10 seconds for response from http request.\n\n\tresponse = sm.execute();//Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\ngs.info(\"Request Body: \" + requestBody);\ngs.info(\"Response: \" + responseBody);\ngs.info(\"HTTP Status: \" + status);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: Direct RESTMessageV2 example\ndescription: You can send an outbound REST message directly to the endpoint.\nkeywords:\n- RESTMessageV2\n- Example direct message\nbreadcrumbs:\n- API implementation and reference\n- API implementation\n- Web services\n- Outbound web services\n- Outbound REST web service\n- Scripting outbound REST\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Direct RESTMessageV2 example\n\nYou can send an outbound REST message directly to the endpoint.\n\nIn this example, the script sends a REST message requesting a stock quote and waits for a\nresponse. If there is no response from the web service provider, or if the specified REST\nmessage record is unavailable, the script throws an error, handled in this example by the\ntry-catch block.\n\n```None\nvar requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n\tsm = new sn_ws.RESTMessageV2(\"Yahoo Finance\", \"get\"); // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm.setBasicAuth(\"admin\",\"admin\");\n\tsm.setStringParameter(\"symbol\", \"NOW\");\n\tsm.setStringParameterNoEscape(\"xml_data\",\"<data>test</data>\");\n\tsm.setHttpTimeout(10000); //In milliseconds. Wait at most 10 seconds for response from http request.\n\n\tresponse = sm.execute();//Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\ngs.info(\"Request Body: \" + requestBody);\ngs.info(\"Response: \" + responseBody);\ngs.info(\"HTTP Status: \" + status);\n```\n"}}},{"rowIdx":1989,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RESTMessageV2 MID server example"},"description":{"kind":"string","value":"You can send an outbound REST message through a MID Server."},"keywords":{"kind":"list like","value":["RESTMessageV2","Example with MID server"],"string":"[\n \"RESTMessageV2\",\n \"Example with MID server\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API implementation","Web services","Outbound web services","Outbound REST web service","Scripting outbound REST"],"string":"[\n \"API implementation and reference\",\n \"API implementation\",\n \"Web services\",\n \"Outbound web services\",\n \"Outbound REST web service\",\n \"Scripting outbound REST\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body id=\"r_RESTMessageV2MIDServerExample\"><main role=\"main\"><article role=\"article\" class=\"dita\" id=\"r_RESTMessageV2MIDServerExample\" aria-labelledby=\"title_r_RESTMessageV2MIDServerExample\">\n <h1 class=\"title topictitle1\" id=\"title_r_RESTMessageV2MIDServerExample\">RESTMessageV2 MID server example</h1>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">You can send an outbound REST message through a MID Server.</p>\n <section class=\"section\">\n <p class=\"p\">By sending the message through a MID Server, you can access endpoints that are behind a\n firewall or within a private network. All REST messages sent through a MID Server are\n asynchronous.</p>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h2 class=\"sectiontitle tasklabel\">Example</h2></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n\tsm = new sn_ws.RESTMessageV2("Yahoo Finance", "get"); // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm.setBasicAuth("admin","admin");\n\tsm.setStringParameter("symbol", "NOW");\n\tsm.setStringParameterNoEscape("xml_data","<data>test</data>");\n\tsm.setMIDServer('mid_server_name');\n\tresponse = sm.executeAsync(); // Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\n\tresponse.waitForResponse(60); // In seconds. Wait at most 60 seconds to get response from ECC Queue/Mid Server //Might throw exception timing out waiting for response in ECC queue.\n\n\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\ngs.info("Request Body: " + requestBody);\ngs.info("Response: " + responseBody);\ngs.info("HTTP Status: " + status);</code></pre>\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This example uses <code class=\"ph codeph\">waitForResponse</code> to pause for a response, and then\n details how the response is handled. However, when using <code class=\"ph codeph\">executeAsync</code>,\n consider processing the response body in a separate business rule to take advantage of the\n asynchronous call rather than using <code class=\"ph codeph\">waitForResponse</code>.</div>\n </div>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API implementation\",\n \"topic_id\": \"build/applications/concept/api-implementation.html\"\n },\n {\n \"title\": \"Web services\",\n \"topic_id\": \"integrate/web-services/reference/r_AvailableWebServices.html\"\n },\n {\n \"title\": \"Outbound web services\",\n \"topic_id\": \"integrate/outbound-web-services/concept/outbound-web-services.html\"\n },\n {\n \"title\": \"Outbound REST web service\",\n \"topic_id\": \"integrate/outbound-rest/concept/c_OutboundRESTWebService.html\"\n },\n {\n \"title\": \"Scripting outbound REST\",\n \"topic_id\": \"integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation.html\\\">API implementation</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/web-services/reference/r_AvailableWebServices.html\\\">Web services</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-web-services/concept/outbound-web-services.html\\\">Outbound web services</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-rest/concept/c_OutboundRESTWebService.html\\\">Outbound REST web service</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\\\">Scripting outbound REST</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RESTMessageV2 MID server example</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206654\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"OutboundRest\",\n \"navtitle\": \"Outbound REST Web Service\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > App development and low-code > Building applications > Outbound REST Web Service\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206654\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"r_RESTMessageV2MIDServerExample\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"RESTMessageV2,Example with MID server\",\n \"DC.type\": \"reference\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"You can send an outbound REST message through a MID Server.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"RESTMessageV2, Example with MID server\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": null,\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\",\n \"page_key\": 41206654,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 1678,\n \"img_count\": 0,\n \"read_time\": 1,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 216\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RESTMessageV2 MID server example\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body id=\\\"r_RESTMessageV2MIDServerExample\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" id=\\\"r_RESTMessageV2MIDServerExample\\\" aria-labelledby=\\\"title_r_RESTMessageV2MIDServerExample\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_r_RESTMessageV2MIDServerExample\\\">RESTMessageV2 MID server example</h1>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">You can send an outbound REST message through a MID Server.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">By sending the message through a MID Server, you can access endpoints that are behind a\\n firewall or within a private network. All REST messages sent through a MID Server are\\n asynchronous.</p>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h2 class=\\\"sectiontitle tasklabel\\\">Example</h2></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var requestBody;\\nvar responseBody;\\nvar status;\\nvar sm;\\ntry{\\n\\tsm = new sn_ws.RESTMessageV2("Yahoo Finance", "get"); // Might throw exception if message doesn't exist or not visible due to scope.\\n\\tsm.setBasicAuth("admin","admin");\\n\\tsm.setStringParameter("symbol", "NOW");\\n\\tsm.setStringParameterNoEscape("xml_data","<data>test</data>");\\n\\tsm.setMIDServer('mid_server_name');\\n\\tresponse = sm.executeAsync(); // Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\\n\\n\\tresponse.waitForResponse(60); // In seconds. Wait at most 60 seconds to get response from ECC Queue/Mid Server //Might throw exception timing out waiting for response in ECC queue.\\n\\n\\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\\n\\tstatus = response.getStatusCode();\\n} catch(ex) {\\n\\tresponseBody = ex.getMessage();\\n\\tstatus = '500';\\n} finally {\\n\\trequestBody = sm ? sm.getRequestBody():null;\\n}\\ngs.info("Request Body: " + requestBody);\\ngs.info("Response: " + responseBody);\\ngs.info("HTTP Status: " + status);</code></pre>\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This example uses <code class=\\\"ph codeph\\\">waitForResponse</code> to pause for a response, and then\\n details how the response is handled. However, when using <code class=\\\"ph codeph\\\">executeAsync</code>,\\n consider processing the response body in a separate business rule to take advantage of the\\n asynchronous call rather than using <code class=\\\"ph codeph\\\">waitForResponse</code>.</div>\\n </div>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RESTMessageV2 MID server example\n\nYou can send an outbound REST message through a MID Server.\n\nBy sending the message through a MID Server, you can access endpoints that are behind a\nfirewall or within a private network. All REST messages sent through a MID Server are\nasynchronous.\n\n## Example\n\n```None\nvar requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n\tsm = new sn_ws.RESTMessageV2(\"Yahoo Finance\", \"get\"); // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm.setBasicAuth(\"admin\",\"admin\");\n\tsm.setStringParameter(\"symbol\", \"NOW\");\n\tsm.setStringParameterNoEscape(\"xml_data\",\"<data>test</data>\");\n\tsm.setMIDServer('mid_server_name');\n\tresponse = sm.executeAsync(); // Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\n\tresponse.waitForResponse(60); // In seconds. Wait at most 60 seconds to get response from ECC Queue/Mid Server //Might throw exception timing out waiting for response in ECC queue.\n\n\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\ngs.info(\"Request Body: \" + requestBody);\ngs.info(\"Response: \" + responseBody);\ngs.info(\"HTTP Status: \" + status);\n```\nNote: This example uses `waitForResponse` to pause for a response, and then\ndetails how the response is handled. However, when using `executeAsync`,\nconsider processing the response body in a separate business rule to take advantage of the\nasynchronous call rather than using `waitForResponse`.\n"},"rich_text":{"kind":"string","value":"---\ntitle: RESTMessageV2 MID server example\ndescription: You can send an outbound REST message through a MID Server.\nkeywords:\n- RESTMessageV2\n- Example with MID server\nbreadcrumbs:\n- API implementation and reference\n- API implementation\n- Web services\n- Outbound web services\n- Outbound REST web service\n- Scripting outbound REST\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RESTMessageV2 MID server example\n\nYou can send an outbound REST message through a MID Server.\n\nBy sending the message through a MID Server, you can access endpoints that are behind a\nfirewall or within a private network. All REST messages sent through a MID Server are\nasynchronous.\n\n## Example\n\n```None\nvar requestBody;\nvar responseBody;\nvar status;\nvar sm;\ntry{\n\tsm = new sn_ws.RESTMessageV2(\"Yahoo Finance\", \"get\"); // Might throw exception if message doesn't exist or not visible due to scope.\n\tsm.setBasicAuth(\"admin\",\"admin\");\n\tsm.setStringParameter(\"symbol\", \"NOW\");\n\tsm.setStringParameterNoEscape(\"xml_data\",\"<data>test</data>\");\n\tsm.setMIDServer('mid_server_name');\n\tresponse = sm.executeAsync(); // Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.\n\n\tresponse.waitForResponse(60); // In seconds. Wait at most 60 seconds to get response from ECC Queue/Mid Server //Might throw exception timing out waiting for response in ECC queue.\n\n\tresponseBody = response.haveError() ? response.getErrorMessage() : response.getBody();\n\tstatus = response.getStatusCode();\n} catch(ex) {\n\tresponseBody = ex.getMessage();\n\tstatus = '500';\n} finally {\n\trequestBody = sm ? sm.getRequestBody():null;\n}\ngs.info(\"Request Body: \" + requestBody);\ngs.info(\"Response: \" + responseBody);\ngs.info(\"HTTP Status: \" + status);\n```\nNote: This example uses `waitForResponse` to pause for a response, and then\ndetails how the response is handled. However, when using `executeAsync`,\nconsider processing the response body in a separate business rule to take advantage of the\nasynchronous call rather than using `waitForResponse`.\n"}}},{"rowIdx":1990,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"Recordless RESTMessageV2 example"},"description":{"kind":"string","value":"You can use the RESTMessageV2() constructor with no parameters to define a REST message entirely in the script."},"keywords":{"kind":"list like","value":["RESTMessageV2","Example empty message"],"string":"[\n \"RESTMessageV2\",\n \"Example empty message\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API implementation","Web services","Outbound web services","Outbound REST web service","Scripting outbound REST"],"string":"[\n \"API implementation and reference\",\n \"API implementation\",\n \"Web services\",\n \"Outbound web services\",\n \"Outbound REST web service\",\n \"Scripting outbound REST\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body id=\"r_RecordlessRESTMessageV2Example\"><main role=\"main\"><article role=\"article\" class=\"dita\" id=\"r_RecordlessRESTMessageV2Example\" aria-labelledby=\"title_r_RecordlessRESTMessageV2Example\">\n <h1 class=\"title topictitle1\" id=\"title_r_RecordlessRESTMessageV2Example\">Recordless RESTMessageV2 example</h1>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">You can use the RESTMessageV2() constructor with no parameters to define a REST message\n entirely in the script.</p>\n <section class=\"section\">\n <p class=\"p\">When using this constructor you must provide an endpoint and HTTP method. In this example,\n the script creates an empty REST message and sets the values needed to insert an incident\n record.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var restMessage = new sn_ws.RESTMessageV2();\nrestMessage.setBasicAuth("admin", "admin");\nrestMessage.setHttpMethod("post");\nrestMessage.setEndpoint("http://<instance>.service-now.com/api/now/table/incident");\nrestMessage.setRequestBody("{\\"short_description\\" : \\"Test incident\\"}");\nvar response = restMessage.execute();</code></pre>\n </section>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API implementation\",\n \"topic_id\": \"build/applications/concept/api-implementation.html\"\n },\n {\n \"title\": \"Web services\",\n \"topic_id\": \"integrate/web-services/reference/r_AvailableWebServices.html\"\n },\n {\n \"title\": \"Outbound web services\",\n \"topic_id\": \"integrate/outbound-web-services/concept/outbound-web-services.html\"\n },\n {\n \"title\": \"Outbound REST web service\",\n \"topic_id\": \"integrate/outbound-rest/concept/c_OutboundRESTWebService.html\"\n },\n {\n \"title\": \"Scripting outbound REST\",\n \"topic_id\": \"integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation.html\\\">API implementation</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/web-services/reference/r_AvailableWebServices.html\\\">Web services</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-web-services/concept/outbound-web-services.html\\\">Outbound web services</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-rest/concept/c_OutboundRESTWebService.html\\\">Outbound REST web service</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\\\">Scripting outbound REST</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">Recordless RESTMessageV2 example</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206656\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"OutboundRest\",\n \"navtitle\": \"Outbound REST Web Service\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > App development and low-code > Building applications > Outbound REST Web Service\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206656\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"r_RecordlessRESTMessageV2Example\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../integrate/outbound-rest/concept/c_ScriptingOutboundREST.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"RESTMessageV2,Example empty message\",\n \"DC.type\": \"reference\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"You can use the RESTMessageV2() constructor with no parameters to define a REST message entirely in the script.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"RESTMessageV2, Example empty message\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": null,\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\",\n \"page_key\": 41206656,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 642,\n \"img_count\": 0,\n \"read_time\": 1,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 67\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"Recordless RESTMessageV2 example\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body id=\\\"r_RecordlessRESTMessageV2Example\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" id=\\\"r_RecordlessRESTMessageV2Example\\\" aria-labelledby=\\\"title_r_RecordlessRESTMessageV2Example\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_r_RecordlessRESTMessageV2Example\\\">Recordless RESTMessageV2 example</h1>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">You can use the RESTMessageV2() constructor with no parameters to define a REST message\\n entirely in the script.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">When using this constructor you must provide an endpoint and HTTP method. In this example,\\n the script creates an empty REST message and sets the values needed to insert an incident\\n record.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var restMessage = new sn_ws.RESTMessageV2();\\nrestMessage.setBasicAuth("admin", "admin");\\nrestMessage.setHttpMethod("post");\\nrestMessage.setEndpoint("http://<instance>.service-now.com/api/now/table/incident");\\nrestMessage.setRequestBody("{\\\\"short_description\\\\" : \\\\"Test incident\\\\"}");\\nvar response = restMessage.execute();</code></pre>\\n </section>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Recordless RESTMessageV2 example\n\nYou can use the RESTMessageV2() constructor with no parameters to define a REST message\nentirely in the script.\n\nWhen using this constructor you must provide an endpoint and HTTP method. In this example,\nthe script creates an empty REST message and sets the values needed to insert an incident\nrecord.\n\n```None\nvar restMessage = new sn_ws.RESTMessageV2();\nrestMessage.setBasicAuth(\"admin\", \"admin\");\nrestMessage.setHttpMethod(\"post\");\nrestMessage.setEndpoint(\"http://<instance>.service-now.com/api/now/table/incident\");\nrestMessage.setRequestBody(\"{\\\"short_description\\\" : \\\"Test incident\\\"}\");\nvar response = restMessage.execute();\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: Recordless RESTMessageV2 example\ndescription: You can use the RESTMessageV2() constructor with no parameters to define\n a REST message entirely in the script.\nkeywords:\n- RESTMessageV2\n- Example empty message\nbreadcrumbs:\n- API implementation and reference\n- API implementation\n- Web services\n- Outbound web services\n- Outbound REST web service\n- Scripting outbound REST\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Recordless RESTMessageV2 example\n\nYou can use the RESTMessageV2() constructor with no parameters to define a REST message\nentirely in the script.\n\nWhen using this constructor you must provide an endpoint and HTTP method. In this example,\nthe script creates an empty REST message and sets the values needed to insert an incident\nrecord.\n\n```None\nvar restMessage = new sn_ws.RESTMessageV2();\nrestMessage.setBasicAuth(\"admin\", \"admin\");\nrestMessage.setHttpMethod(\"post\");\nrestMessage.setEndpoint(\"http://<instance>.service-now.com/api/now/table/incident\");\nrestMessage.setRequestBody(\"{\\\"short_description\\\" : \\\"Test incident\\\"}\");\nvar response = restMessage.execute();\n```\n"}}},{"rowIdx":1991,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RESTResponseV2 - Scoped, Global"},"description":{"kind":"string","value":"The RESTResponseV2 API allows you to use the data returned by an outbound REST message in JavaScript code."},"keywords":{"kind":"list like","value":["RESTResponseV2","RESTResponseV2","getAllHeaders()","getBody()","getCookies()","getErrorCode()","getHeader(String name)","getHeaders()","getQueryString()","getResponseAttachmentSysid()","getStatusCode()","haveError()","waitForResponse(Number timeoutSecs)"],"string":"[\n \"RESTResponseV2\",\n \"RESTResponseV2\",\n \"getAllHeaders()\",\n \"getBody()\",\n \"getCookies()\",\n \"getErrorCode()\",\n \"getHeader(String name)\",\n \"getHeaders()\",\n \"getQueryString()\",\n \"getResponseAttachmentSysid()\",\n \"getStatusCode()\",\n \"haveError()\",\n \"waitForResponse(Number timeoutSecs)\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api\"><main role=\"main\"><article role=\"article\" class=\"api dita\" aria-labelledby=\"title_c_RESTResponseV2API\"><article class=\"nested0\" aria-labelledby=\"title_c_RESTResponseV2API\" id=\"c_RESTResponseV2API\">\n <h1 class=\"title topictitle1\" id=\"title_c_RESTResponseV2API\">RESTResponseV2 - Scoped, Global</h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RESTResponseV2</span> API allows you to use the data returned by an\n outbound REST message in JavaScript code.</p>\n <p class=\"p\">A RESTResponseV2 object is returned by the <span class=\"keyword apiname\">RESTMessageV2</span> methods\n <span class=\"keyword apiname\">execute()</span> and <span class=\"keyword apiname\">executeAsync()</span>.</p>\n <p class=\"p\">You can use this API in scoped applications, or within the global scope. This API runs in the <code class=\"ph codeph\">sn_ws</code> namespace.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RRV2-getAllHeaders\" id=\"RRV2-getAllHeaders\">\n <h2 class=\"title topictitle2\" id=\"title_RRV2-getAllHeaders\">RESTResponseV2 - getAllHeaders()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns all headers contained in the response, including any duplicate\n headers.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RRV2-getAllHeaders__table_hyh_l1l_gz\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RRV2-getAllHeaders__table_iyh_l1l_gz\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__1\">List<GlideHTTPHeader></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__2\">List of headers contained in the response. Each header is represented as a\n GlideHTTPHeader object which contains the header <var class=\"keyword varname\">name</var> and\n <var class=\"keyword varname\">value</var>.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The follow code example shows how to call the REST Table API and then lists out all of the\n headers found in the response.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var request = new sn_ws.RESTMessageV2();\nrequest.setEndpoint('http://<SN_Instance_host>/api/now/table/incident');\nrequest.setHttpMethod('GET');\n\nrequest.setBasicAuth('username', 'password');\nrequest.setRequestHeader("Accept", "application/json");\nvar res = request.execute();\nif (res.getStatusCode() != 200) {\n gs.info('Bad Request');\n}\n\nvar headers = res.getAllHeaders();\nfor(var i in headers){\n gs.info(headers[i].name + ': ' + headers[i].value);\n}</code></pre>\n <p class=\"p\">Response headers</p>\n <pre class=\"prettyprint language-plaintext\"><code lang=\"plaintext\" class=\"pre codeblock language-plaintext\">X-Is-Logged-In: true\nX-Transaction-ID: e3003cb2db8c\nX-Total-Count: 66\nX-Content-Type-Options: nosniff\nPragma: no-store,no-cache\nCache-Control: no-cache,no-store,must-revalidate,max-age=-1\nExpires: 0\nContent-Type: application/json;charset=UTF-8\nDate: Fri, 14 May 2021 16:05:10 GMT\nConnection: close\nServer: ServiceNow\nJSESSIONID=5041870726ADADFAB2EE2BF8E7E01596; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user_session=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user_route=glide.f1aa2015b3fa5fa8dfe567386cde8fd5; Max-Age=2147483647; Expires=Wed, 01-Jun-2089 19:19:17 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_session_store=AF003CB2DB8CF8103DD9C39D139619C7; Max-Age=1800; Expires=Fri, 14-May-2021 16:35:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: BIGipServerpool_ddershem=2643023626.45630.0000; path=/; Httponly; Secure; SameSite=None; Secure\nStrict-Transport-Security: max-age=63072000; includeSubDomains</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getBody\" id=\"r_RESTResponseV2-getBody\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getBody\">RESTResponseV2 - getBody()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the content of the REST response body.</p>\n <section class=\"section\">\n <p class=\"p\">Use this function when you want to get the request body as text content. Do not use this\n method when saving the response as a binary attachment. If a RESTMessageV2 object called the\n <span class=\"keyword apiname\">saveResponseBodyAsAttachment(...)</span> function, using\n <span class=\"keyword apiname\">getBody()</span> on the associated RESTResponseV2 object will cause an error.\n When saving the response as an attachment, if the outbound REST message fails, call\n <span class=\"keyword apiname\">getErrorMessage()</span> on the response to retrieve the body content.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getBody__table_vy2_525_jqg\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getBody__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__2\">REST response body.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar responseBody = response.getBody();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getCookies\" id=\"r_RESTResponseV2-getCookies\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getCookies\">RESTResponseV2 - getCookies()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns all cookies included in the response.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__2\">Array of strings representing cookies. Iterate through the array to perform\n operations on each cookie.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"r_RESTResponseV2-getCookies__example_y2r_l3r_npb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">Display individual cookies from the response.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var cookies = response.getCookies();\nfor (var i = 0; i < cookies.length; i++) {\n gs.info('cookie: ' + cookies.get(i));\n}</code></pre>\n <div class=\"p\">Output:\n <pre class=\"prettyprint language-plaintext\"><code lang=\"plaintext\" class=\"pre codeblock language-plaintext\">cookie: JSESSIONID=4135AA97A5D12DA22EF614AA2B0CAFD8.node20; Path=/; Secure; HttpOnly\ncookie: SABASESSIONID=370152970.36895.0000; path=/</code></pre></div>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getErrorCode\" id=\"r_RESTResponseV2-getErrorCode\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getErrorCode\">RESTResponseV2 - getErrorCode()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the numeric error code if there was an error during the REST transaction.</p>\n <section class=\"section\">\n <p class=\"p\">This error code is specific to the <span class=\"ph\">Now Platform</span>, it is not an HTTP error code.\n Provide this error code if you require assistance from ServiceNow Customer Support.</p>\n <div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> To retrieve the contents of the actual error message, use the <a class=\"xref\" href=\"#r_RESTResponseV2-getBody\" title=\"Gets the content of the REST response body.\">getBody()</a> method.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__1\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__2\">Numeric error code, such as 1 for socket timeout.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar errorCode = response.getErrorCode();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getErrorMessage\" id=\"r_RESTResponseV2-getErrorMessage\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getErrorMessage\">RESTResponseV2 - getErrorMessage()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the error message if there was an error during the REST transaction.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__2\">Error message.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar errorMsg = response.getErrorMessage();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getHeader_S\" id=\"r_RESTResponseV2-getHeader_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getHeader_S\">RESTResponseV2 - getHeader(String name)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the value for a specified header.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__3\">Name of the header that you want the value for, such as Set-Cookie.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__2\">Value of the specified header.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar headerVal = response.getHeader("Content-Type");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getHeaders\" id=\"r_RESTResponseV2-getHeaders\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getHeaders\">RESTResponseV2 - getHeaders()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets all headers returned in the REST response and the associated values.</p>\n <section class=\"section\">\n <div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> If a header is present more than once in the response, such as a Set-Cookie header,\n this function returns only the last of the duplicate headers. To return all headers\n including duplicates, use the <span class=\"keyword apiname\">getAllHeaders()</span> function.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__2\">Object that maps the name of each header to the associated value.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar headers = response.getHeaders();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getQueryString\" id=\"r_RESTResponseV2-getQueryString\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getQueryString\">RESTResponseV2 - getQueryString()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the fully-resolved query sent to the REST endpoint..</p>\n <section class=\"section\">\n <p class=\"p\">This query contains the endpoint URL as well as any values assigned to variables in the\n REST message. Use this method only with responses to direct requests. This method is not\n supported for requests sent asynchronously, or requests sent using a MID server.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk\"><caption><span class=\"table--title-label\">Table 15. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 16. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__2\">Fully-resolved query.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar queryString = response.getQueryString();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RRV2-getResponseAttachmentSysid\" id=\"r_RRV2-getResponseAttachmentSysid\">\n <h2 class=\"title topictitle2\" id=\"title_r_RRV2-getResponseAttachmentSysid\">RESTResponseV2 - getResponseAttachmentSysid()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the sys_id value of the attachment created from the response body\n content.</p>\n <section class=\"section\">\n <p class=\"p\">If the RESTMessageV2 object associated with this response called the\n <span class=\"keyword apiname\">saveResponseBodyAsAttachment(...)</span> function, use\n <span class=\"keyword apiname\">getResponseAttachmentSysid()</span> to get the sys_id of the created\n attachment record. Use this function when you want to perform additional operations with the\n new attachment record.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs\"><caption><span class=\"table--title-label\">Table 17. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs\"><caption><span class=\"table--title-label\">Table 18. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__2\">Sys_id of the new attachment record.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-getStatusCode\" id=\"r_RESTResponseV2-getStatusCode\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-getStatusCode\">RESTResponseV2 - getStatusCode()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the numeric HTTP status code returned by the REST provider.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql\"><caption><span class=\"table--title-label\">Table 19. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 20. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__1\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__2\">Numeric status code returned by the REST provider, such as 200 for a successful\n response.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar statusCode = response.getStatusCode();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-haveError\" id=\"r_RESTResponseV2-haveError\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-haveError\">RESTResponseV2 - haveError()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Indicates if there was an error during the REST transaction.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-haveError__table_vy2_525_jqm\"><caption><span class=\"table--title-label\">Table 21. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-haveError__table_qpt_3f5_jq\"><caption><span class=\"table--title-label\">Table 22. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__1\">boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__2\">Returns true if there was an error, false if there was no error.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar error = response.haveError();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RESTResponseV2-waitForResponse_N\" id=\"r_RESTResponseV2-waitForResponse_N\">\n <h2 class=\"title topictitle2\" id=\"title_r_RESTResponseV2-waitForResponse_N\">RESTResponseV2 - waitForResponse(Number timeoutSecs)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Set the amount of time the instance waits for a response from the web service\n provider.</p>\n <section class=\"section\">\n <p class=\"p\">This method overrides the property glide.rest.outbound.ecc_response.timeout for this REST\n response.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq\"><caption><span class=\"table--title-label\">Table 23. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__1\">timeoutSecs</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__3\">The amount of time, in seconds, to wait for this response.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr\"><caption><span class=\"table--title-label\">Table 24. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.executeAsync();\nresponse.waitForResponse(60);</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RESTResponseV2 - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206662\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206662\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"c_RESTResponseV2API\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"RESTResponseV2,RESTResponseV2,getAllHeaders(),getBody(),getCookies(),getErrorCode(),getHeader(String name),getHeaders(),getQueryString(),getResponseAttachmentSysid(),getStatusCode(),haveError(),waitForResponse(Number timeoutSecs)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RESTResponseV2 API allows you to use the data returned by an outbound REST message in JavaScript code.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"RESTResponseV2, RESTResponseV2, getAllHeaders(), getBody(), getCookies(), getErrorCode(), getHeader(String name), getHeaders(), getQueryString(), getResponseAttachmentSysid(), getStatusCode(), haveError(), waitForResponse(Number timeoutSecs)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\",\n \"page_key\": 41206662,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 8410,\n \"img_count\": 0,\n \"read_time\": 5,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 1074\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RESTResponseV2 - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api dita\\\" aria-labelledby=\\\"title_c_RESTResponseV2API\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_c_RESTResponseV2API\\\" id=\\\"c_RESTResponseV2API\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_c_RESTResponseV2API\\\">RESTResponseV2 - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RESTResponseV2</span> API allows you to use the data returned by an\\n outbound REST message in JavaScript code.</p>\\n <p class=\\\"p\\\">A RESTResponseV2 object is returned by the <span class=\\\"keyword apiname\\\">RESTMessageV2</span> methods\\n <span class=\\\"keyword apiname\\\">execute()</span> and <span class=\\\"keyword apiname\\\">executeAsync()</span>.</p>\\n <p class=\\\"p\\\">You can use this API in scoped applications, or within the global scope. This API runs in the <code class=\\\"ph codeph\\\">sn_ws</code> namespace.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RRV2-getAllHeaders\\\" id=\\\"RRV2-getAllHeaders\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RRV2-getAllHeaders\\\">RESTResponseV2 - getAllHeaders()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns all headers contained in the response, including any duplicate\\n headers.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RRV2-getAllHeaders__table_hyh_l1l_gz\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RRV2-getAllHeaders__table_hyh_l1l_gz__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RRV2-getAllHeaders__table_iyh_l1l_gz\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__1\\\">List<GlideHTTPHeader></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RRV2-getAllHeaders__table_iyh_l1l_gz__entry__2\\\">List of headers contained in the response. Each header is represented as a\\n GlideHTTPHeader object which contains the header <var class=\\\"keyword varname\\\">name</var> and\\n <var class=\\\"keyword varname\\\">value</var>.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The follow code example shows how to call the REST Table API and then lists out all of the\\n headers found in the response.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var request = new sn_ws.RESTMessageV2();\\nrequest.setEndpoint('http://<SN_Instance_host>/api/now/table/incident');\\nrequest.setHttpMethod('GET');\\n\\nrequest.setBasicAuth('username', 'password');\\nrequest.setRequestHeader("Accept", "application/json");\\nvar res = request.execute();\\nif (res.getStatusCode() != 200) {\\n gs.info('Bad Request');\\n}\\n\\nvar headers = res.getAllHeaders();\\nfor(var i in headers){\\n gs.info(headers[i].name + ': ' + headers[i].value);\\n}</code></pre>\\n <p class=\\\"p\\\">Response headers</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code lang=\\\"plaintext\\\" class=\\\"pre codeblock language-plaintext\\\">X-Is-Logged-In: true\\nX-Transaction-ID: e3003cb2db8c\\nX-Total-Count: 66\\nX-Content-Type-Options: nosniff\\nPragma: no-store,no-cache\\nCache-Control: no-cache,no-store,must-revalidate,max-age=-1\\nExpires: 0\\nContent-Type: application/json;charset=UTF-8\\nDate: Fri, 14 May 2021 16:05:10 GMT\\nConnection: close\\nServer: ServiceNow\\nJSESSIONID=5041870726ADADFAB2EE2BF8E7E01596; Path=/; HttpOnly; SameSite=None; Secure\\nSet-Cookie: glide_user=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\\nSet-Cookie: glide_user_session=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\\nSet-Cookie: glide_user_route=glide.f1aa2015b3fa5fa8dfe567386cde8fd5; Max-Age=2147483647; Expires=Wed, 01-Jun-2089 19:19:17 GMT; Path=/; HttpOnly; SameSite=None; Secure\\nSet-Cookie: glide_session_store=AF003CB2DB8CF8103DD9C39D139619C7; Max-Age=1800; Expires=Fri, 14-May-2021 16:35:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\\nSet-Cookie: BIGipServerpool_ddershem=2643023626.45630.0000; path=/; Httponly; Secure; SameSite=None; Secure\\nStrict-Transport-Security: max-age=63072000; includeSubDomains</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getBody\\\" id=\\\"r_RESTResponseV2-getBody\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getBody\\\">RESTResponseV2 - getBody()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the content of the REST response body.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Use this function when you want to get the request body as text content. Do not use this\\n method when saving the response as a binary attachment. If a RESTMessageV2 object called the\\n <span class=\\\"keyword apiname\\\">saveResponseBodyAsAttachment(...)</span> function, using\\n <span class=\\\"keyword apiname\\\">getBody()</span> on the associated RESTResponseV2 object will cause an error.\\n When saving the response as an attachment, if the outbound REST message fails, call\\n <span class=\\\"keyword apiname\\\">getErrorMessage()</span> on the response to retrieve the body content.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getBody__table_vy2_525_jqg\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getBody__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__2\\\">REST response body.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar responseBody = response.getBody();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getCookies\\\" id=\\\"r_RESTResponseV2-getCookies\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getCookies\\\">RESTResponseV2 - getCookies()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns all cookies included in the response.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__2\\\">Array of strings representing cookies. Iterate through the array to perform\\n operations on each cookie.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"r_RESTResponseV2-getCookies__example_y2r_l3r_npb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">Display individual cookies from the response.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var cookies = response.getCookies();\\nfor (var i = 0; i < cookies.length; i++) {\\n gs.info('cookie: ' + cookies.get(i));\\n}</code></pre>\\n <div class=\\\"p\\\">Output:\\n <pre class=\\\"prettyprint language-plaintext\\\"><code lang=\\\"plaintext\\\" class=\\\"pre codeblock language-plaintext\\\">cookie: JSESSIONID=4135AA97A5D12DA22EF614AA2B0CAFD8.node20; Path=/; Secure; HttpOnly\\ncookie: SABASESSIONID=370152970.36895.0000; path=/</code></pre></div>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getErrorCode\\\" id=\\\"r_RESTResponseV2-getErrorCode\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getErrorCode\\\">RESTResponseV2 - getErrorCode()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the numeric error code if there was an error during the REST transaction.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">This error code is specific to the <span class=\\\"ph\\\">Now Platform</span>, it is not an HTTP error code.\\n Provide this error code if you require assistance from ServiceNow Customer Support.</p>\\n <div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> To retrieve the contents of the actual error message, use the <a class=\\\"xref\\\" href=\\\"#r_RESTResponseV2-getBody\\\" title=\\\"Gets the content of the REST response body.\\\">getBody()</a> method.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__1\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__2\\\">Numeric error code, such as 1 for socket timeout.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar errorCode = response.getErrorCode();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getErrorMessage\\\" id=\\\"r_RESTResponseV2-getErrorMessage\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getErrorMessage\\\">RESTResponseV2 - getErrorMessage()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the error message if there was an error during the REST transaction.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__2\\\">Error message.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar errorMsg = response.getErrorMessage();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getHeader_S\\\" id=\\\"r_RESTResponseV2-getHeader_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getHeader_S\\\">RESTResponseV2 - getHeader(String name)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the value for a specified header.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__3\\\">Name of the header that you want the value for, such as Set-Cookie.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__2\\\">Value of the specified header.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar headerVal = response.getHeader("Content-Type");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getHeaders\\\" id=\\\"r_RESTResponseV2-getHeaders\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getHeaders\\\">RESTResponseV2 - getHeaders()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets all headers returned in the REST response and the associated values.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> If a header is present more than once in the response, such as a Set-Cookie header,\\n this function returns only the last of the duplicate headers. To return all headers\\n including duplicates, use the <span class=\\\"keyword apiname\\\">getAllHeaders()</span> function.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__2\\\">Object that maps the name of each header to the associated value.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar headers = response.getHeaders();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getQueryString\\\" id=\\\"r_RESTResponseV2-getQueryString\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getQueryString\\\">RESTResponseV2 - getQueryString()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the fully-resolved query sent to the REST endpoint..</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">This query contains the endpoint URL as well as any values assigned to variables in the\\n REST message. Use this method only with responses to direct requests. This method is not\\n supported for requests sent asynchronously, or requests sent using a MID server.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__2\\\">Fully-resolved query.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar queryString = response.getQueryString();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RRV2-getResponseAttachmentSysid\\\" id=\\\"r_RRV2-getResponseAttachmentSysid\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RRV2-getResponseAttachmentSysid\\\">RESTResponseV2 - getResponseAttachmentSysid()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the sys_id value of the attachment created from the response body\\n content.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">If the RESTMessageV2 object associated with this response called the\\n <span class=\\\"keyword apiname\\\">saveResponseBodyAsAttachment(...)</span> function, use\\n <span class=\\\"keyword apiname\\\">getResponseAttachmentSysid()</span> to get the sys_id of the created\\n attachment record. Use this function when you want to perform additional operations with the\\n new attachment record.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__2\\\">Sys_id of the new attachment record.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-getStatusCode\\\" id=\\\"r_RESTResponseV2-getStatusCode\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-getStatusCode\\\">RESTResponseV2 - getStatusCode()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the numeric HTTP status code returned by the REST provider.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql\\\"><caption><span class=\\\"table--title-label\\\">Table 19. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 20. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__1\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__2\\\">Numeric status code returned by the REST provider, such as 200 for a successful\\n response.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar statusCode = response.getStatusCode();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-haveError\\\" id=\\\"r_RESTResponseV2-haveError\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-haveError\\\">RESTResponseV2 - haveError()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Indicates if there was an error during the REST transaction.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-haveError__table_vy2_525_jqm\\\"><caption><span class=\\\"table--title-label\\\">Table 21. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-haveError__table_qpt_3f5_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 22. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__1\\\">boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__2\\\">Returns true if there was an error, false if there was no error.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.execute();\\nvar error = response.haveError();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RESTResponseV2-waitForResponse_N\\\" id=\\\"r_RESTResponseV2-waitForResponse_N\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RESTResponseV2-waitForResponse_N\\\">RESTResponseV2 - waitForResponse(Number timeoutSecs)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Set the amount of time the instance waits for a response from the web service\\n provider.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">This method overrides the property glide.rest.outbound.ecc_response.timeout for this REST\\n response.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq\\\"><caption><span class=\\\"table--title-label\\\">Table 23. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__1\\\">timeoutSecs</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__3\\\">The amount of time, in seconds, to wait for this response.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr\\\"><caption><span class=\\\"table--title-label\\\">Table 24. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.\\nvar response = sm.executeAsync();\\nresponse.waitForResponse(60);</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RESTResponseV2 - Scoped, Global\n\nThe RESTResponseV2 API allows you to use the data returned by an\noutbound REST message in JavaScript code.\n\nA RESTResponseV2 object is returned by the RESTMessageV2 methods\nexecute() and executeAsync().\n\nYou can use this API in scoped applications, or within the global scope. This API runs in the `sn_ws` namespace.\n\n## RESTResponseV2 - getAllHeaders()\n\nReturns all headers contained in the response, including any duplicate\nheaders.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| List<GlideHTTPHeader> | List of headers contained in the response. Each header is represented as a GlideHTTPHeader object which contains the header name and value. |\n\n### Example\n\nThe follow code example shows how to call the REST Table API and then lists out all of the\nheaders found in the response.\n\n```None\nvar request = new sn_ws.RESTMessageV2();\nrequest.setEndpoint('http://<SN_Instance_host>/api/now/table/incident');\nrequest.setHttpMethod('GET');\n\nrequest.setBasicAuth('username', 'password');\nrequest.setRequestHeader(\"Accept\", \"application/json\");\nvar res = request.execute();\nif (res.getStatusCode() != 200) {\n gs.info('Bad Request');\n}\n\nvar headers = res.getAllHeaders();\nfor(var i in headers){\n gs.info(headers[i].name + ': ' + headers[i].value);\n}\n```\n\nResponse headers\n\n```None\nX-Is-Logged-In: true\nX-Transaction-ID: e3003cb2db8c\nX-Total-Count: 66\nX-Content-Type-Options: nosniff\nPragma: no-store,no-cache\nCache-Control: no-cache,no-store,must-revalidate,max-age=-1\nExpires: 0\nContent-Type: application/json;charset=UTF-8\nDate: Fri, 14 May 2021 16:05:10 GMT\nConnection: close\nServer: ServiceNow\nJSESSIONID=5041870726ADADFAB2EE2BF8E7E01596; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user_session=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user_route=glide.f1aa2015b3fa5fa8dfe567386cde8fd5; Max-Age=2147483647; Expires=Wed, 01-Jun-2089 19:19:17 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_session_store=AF003CB2DB8CF8103DD9C39D139619C7; Max-Age=1800; Expires=Fri, 14-May-2021 16:35:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: BIGipServerpool_ddershem=2643023626.45630.0000; path=/; Httponly; Secure; SameSite=None; Secure\nStrict-Transport-Security: max-age=63072000; includeSubDomains\n```\n\n## RESTResponseV2 - getBody()\n\nGets the content of the REST response body.\n\nUse this function when you want to get the request body as text content. Do not use this\nmethod when saving the response as a binary attachment. If a RESTMessageV2 object called the\nsaveResponseBodyAsAttachment(...) function, using\ngetBody() on the associated RESTResponseV2 object will cause an error.\nWhen saving the response as an attachment, if the outbound REST message fails, call\ngetErrorMessage() on the response to retrieve the body content.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | REST response body. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar responseBody = response.getBody();\n```\n\n## RESTResponseV2 - getCookies()\n\nReturns all cookies included in the response.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | Array of strings representing cookies. Iterate through the array to perform operations on each cookie. |\n\n### Example\n\nDisplay individual cookies from the response.\n\n```None\nvar cookies = response.getCookies();\nfor (var i = 0; i < cookies.length; i++) {\n gs.info('cookie: ' + cookies.get(i));\n}\n```\nOutput:\n```None\ncookie: JSESSIONID=4135AA97A5D12DA22EF614AA2B0CAFD8.node20; Path=/; Secure; HttpOnly\ncookie: SABASESSIONID=370152970.36895.0000; path=/\n```\n\n## RESTResponseV2 - getErrorCode()\n\nGets the numeric error code if there was an error during the REST transaction.\n\nThis error code is specific to the Now Platform, it is not an HTTP error code.\nProvide this error code if you require assistance from ServiceNow Customer Support.\n\nNote: To retrieve the contents of the actual error message, use the getBody() method.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Number | Numeric error code, such as 1 for socket timeout. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar errorCode = response.getErrorCode();\n```\n\n## RESTResponseV2 - getErrorMessage()\n\nGets the error message if there was an error during the REST transaction.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | Error message. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar errorMsg = response.getErrorMessage();\n```\n\n## RESTResponseV2 - getHeader(String name)\n\nGets the value for a specified header.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the header that you want the value for, such as Set-Cookie. |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | Value of the specified header. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar headerVal = response.getHeader(\"Content-Type\");\n```\n\n## RESTResponseV2 - getHeaders()\n\nGets all headers returned in the REST response and the associated values.\n\nNote: If a header is present more than once in the response, such as a Set-Cookie header,\nthis function returns only the last of the duplicate headers. To return all headers\nincluding duplicates, use the getAllHeaders() function.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | Object that maps the name of each header to the associated value. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar headers = response.getHeaders();\n```\n\n## RESTResponseV2 - getQueryString()\n\nGets the fully-resolved query sent to the REST endpoint..\n\nThis query contains the endpoint URL as well as any values assigned to variables in the\nREST message. Use this method only with responses to direct requests. This method is not\nsupported for requests sent asynchronously, or requests sent using a MID server.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| String | Fully-resolved query. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar queryString = response.getQueryString();\n```\n\n## RESTResponseV2 - getResponseAttachmentSysid()\n\nGets the sys\\_id value of the attachment created from the response body\ncontent.\n\nIf the RESTMessageV2 object associated with this response called the\nsaveResponseBodyAsAttachment(...) function, use\ngetResponseAttachmentSysid() to get the sys\\_id of the created\nattachment record. Use this function when you want to perform additional operations with the\nnew attachment record.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| String | Sys\\_id of the new attachment record. |\n\n## RESTResponseV2 - getStatusCode()\n\nGets the numeric HTTP status code returned by the REST provider.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Number | Numeric status code returned by the REST provider, such as 200 for a successful response. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar statusCode = response.getStatusCode();\n```\n\n## RESTResponseV2 - haveError()\n\nIndicates if there was an error during the REST transaction.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| boolean | Returns true if there was an error, false if there was no error. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar error = response.haveError();\n```\n\n## RESTResponseV2 - waitForResponse(Number timeoutSecs)\n\nSet the amount of time the instance waits for a response from the web service\nprovider.\n\nThis method overrides the property glide.rest.outbound.ecc\\_response.timeout for this REST\nresponse.\n\nTable 23. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| timeoutSecs | Number | The amount of time, in seconds, to wait for this response. |\n\nTable 24. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.executeAsync();\nresponse.waitForResponse(60);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RESTResponseV2 - Scoped, Global\ndescription: The RESTResponseV2 API allows you to use the data returned by an outbound\n REST message in JavaScript code.\nkeywords:\n- RESTResponseV2\n- RESTResponseV2\n- getAllHeaders()\n- getBody()\n- getCookies()\n- getErrorCode()\n- getHeader(String name)\n- getHeaders()\n- getQueryString()\n- getResponseAttachmentSysid()\n- getStatusCode()\n- haveError()\n- waitForResponse(Number timeoutSecs)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RESTResponseV2 - Scoped, Global\n\nThe RESTResponseV2 API allows you to use the data returned by an\noutbound REST message in JavaScript code.\n\nA RESTResponseV2 object is returned by the RESTMessageV2 methods\nexecute() and executeAsync().\n\nYou can use this API in scoped applications, or within the global scope. This API runs in the `sn_ws` namespace.\n\n## RESTResponseV2 - getAllHeaders()\n\nReturns all headers contained in the response, including any duplicate\nheaders.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| List<GlideHTTPHeader> | List of headers contained in the response. Each header is represented as a GlideHTTPHeader object which contains the header name and value. |\n\n### Example\n\nThe follow code example shows how to call the REST Table API and then lists out all of the\nheaders found in the response.\n\n```None\nvar request = new sn_ws.RESTMessageV2();\nrequest.setEndpoint('http://<SN_Instance_host>/api/now/table/incident');\nrequest.setHttpMethod('GET');\n\nrequest.setBasicAuth('username', 'password');\nrequest.setRequestHeader(\"Accept\", \"application/json\");\nvar res = request.execute();\nif (res.getStatusCode() != 200) {\n gs.info('Bad Request');\n}\n\nvar headers = res.getAllHeaders();\nfor(var i in headers){\n gs.info(headers[i].name + ': ' + headers[i].value);\n}\n```\n\nResponse headers\n\n```None\nX-Is-Logged-In: true\nX-Transaction-ID: e3003cb2db8c\nX-Total-Count: 66\nX-Content-Type-Options: nosniff\nPragma: no-store,no-cache\nCache-Control: no-cache,no-store,must-revalidate,max-age=-1\nExpires: 0\nContent-Type: application/json;charset=UTF-8\nDate: Fri, 14 May 2021 16:05:10 GMT\nConnection: close\nServer: ServiceNow\nJSESSIONID=5041870726ADADFAB2EE2BF8E7E01596; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user_session=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_user_route=glide.f1aa2015b3fa5fa8dfe567386cde8fd5; Max-Age=2147483647; Expires=Wed, 01-Jun-2089 19:19:17 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: glide_session_store=AF003CB2DB8CF8103DD9C39D139619C7; Max-Age=1800; Expires=Fri, 14-May-2021 16:35:10 GMT; Path=/; HttpOnly; SameSite=None; Secure\nSet-Cookie: BIGipServerpool_ddershem=2643023626.45630.0000; path=/; Httponly; Secure; SameSite=None; Secure\nStrict-Transport-Security: max-age=63072000; includeSubDomains\n```\n\n## RESTResponseV2 - getBody()\n\nGets the content of the REST response body.\n\nUse this function when you want to get the request body as text content. Do not use this\nmethod when saving the response as a binary attachment. If a RESTMessageV2 object called the\nsaveResponseBodyAsAttachment(...) function, using\ngetBody() on the associated RESTResponseV2 object will cause an error.\nWhen saving the response as an attachment, if the outbound REST message fails, call\ngetErrorMessage() on the response to retrieve the body content.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | REST response body. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar responseBody = response.getBody();\n```\n\n## RESTResponseV2 - getCookies()\n\nReturns all cookies included in the response.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | Array of strings representing cookies. Iterate through the array to perform operations on each cookie. |\n\n### Example\n\nDisplay individual cookies from the response.\n\n```None\nvar cookies = response.getCookies();\nfor (var i = 0; i < cookies.length; i++) {\n gs.info('cookie: ' + cookies.get(i));\n}\n```\nOutput:\n```None\ncookie: JSESSIONID=4135AA97A5D12DA22EF614AA2B0CAFD8.node20; Path=/; Secure; HttpOnly\ncookie: SABASESSIONID=370152970.36895.0000; path=/\n```\n\n## RESTResponseV2 - getErrorCode()\n\nGets the numeric error code if there was an error during the REST transaction.\n\nThis error code is specific to the Now Platform, it is not an HTTP error code.\nProvide this error code if you require assistance from ServiceNow Customer Support.\n\nNote: To retrieve the contents of the actual error message, use the getBody() method.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Number | Numeric error code, such as 1 for socket timeout. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar errorCode = response.getErrorCode();\n```\n\n## RESTResponseV2 - getErrorMessage()\n\nGets the error message if there was an error during the REST transaction.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | Error message. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar errorMsg = response.getErrorMessage();\n```\n\n## RESTResponseV2 - getHeader(String name)\n\nGets the value for a specified header.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the header that you want the value for, such as Set-Cookie. |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | Value of the specified header. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar headerVal = response.getHeader(\"Content-Type\");\n```\n\n## RESTResponseV2 - getHeaders()\n\nGets all headers returned in the REST response and the associated values.\n\nNote: If a header is present more than once in the response, such as a Set-Cookie header,\nthis function returns only the last of the duplicate headers. To return all headers\nincluding duplicates, use the getAllHeaders() function.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | Object that maps the name of each header to the associated value. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar headers = response.getHeaders();\n```\n\n## RESTResponseV2 - getQueryString()\n\nGets the fully-resolved query sent to the REST endpoint..\n\nThis query contains the endpoint URL as well as any values assigned to variables in the\nREST message. Use this method only with responses to direct requests. This method is not\nsupported for requests sent asynchronously, or requests sent using a MID server.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| String | Fully-resolved query. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar queryString = response.getQueryString();\n```\n\n## RESTResponseV2 - getResponseAttachmentSysid()\n\nGets the sys\\_id value of the attachment created from the response body\ncontent.\n\nIf the RESTMessageV2 object associated with this response called the\nsaveResponseBodyAsAttachment(...) function, use\ngetResponseAttachmentSysid() to get the sys\\_id of the created\nattachment record. Use this function when you want to perform additional operations with the\nnew attachment record.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| String | Sys\\_id of the new attachment record. |\n\n## RESTResponseV2 - getStatusCode()\n\nGets the numeric HTTP status code returned by the REST provider.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Number | Numeric status code returned by the REST provider, such as 200 for a successful response. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar statusCode = response.getStatusCode();\n```\n\n## RESTResponseV2 - haveError()\n\nIndicates if there was an error during the REST transaction.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| boolean | Returns true if there was an error, false if there was no error. |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.execute();\nvar error = response.haveError();\n```\n\n## RESTResponseV2 - waitForResponse(Number timeoutSecs)\n\nSet the amount of time the instance waits for a response from the web service\nprovider.\n\nThis method overrides the property glide.rest.outbound.ecc\\_response.timeout for this REST\nresponse.\n\nTable 23. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| timeoutSecs | Number | The amount of time, in seconds, to wait for this response. |\n\nTable 24. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar sm = new sn_ws.RESTMessageV2(\"Yahoo Finance\",\"get\"); //Might throw exception if message doesn't exist or not visible due to scope.\nvar response = sm.executeAsync();\nresponse.waitForResponse(60);\n```\n"}}},{"rowIdx":1992,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RTETransformer - Scoped"},"description":{"kind":"string","value":"The RTETransformer API provides a method to transform and store an array of messages into a record in the associated ServiceNow instance based on a provided extract, transform, and load (ETL) definition."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_RTETransScopedAPI\"><article class=\"nested0\" aria-labelledby=\"title_RTETransScopedAPI\" id=\"RTETransScopedAPI\">\n <h1 class=\"title topictitle1\" id=\"title_RTETransScopedAPI\">RTETransformer<span class=\"ph\"> - Scoped</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RTETransformer</span> API provides a method to transform and store an\n array of messages into a record in the associated <span class=\"ph\">ServiceNow</span> instance\n based on a provided extract, transform, and load (ETL) definition.</p>\n <section class=\"section\">\n <p class=\"p\">For example, use this API when you have JSON payload(s) that contain user information and\n you want to transform that information into the sys_user table using the Robust Transform\n Engine (RTE).</p>\n <p class=\"p\">Use the <code class=\"ph codeph\">sn_impex</code> namespace when accessing this API.</p>\n <p class=\"p\">For additional information, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RTETransformer/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=define-rte-operations&version=vancouver&pubname=vancouver-integrate-applications\" class=\"xref\">Define Robust Transform Engine\n operations</a>.</p>\n </section>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_RTETrans-RTETrans_S_B_S_N\" id=\"RTETrans-RTETrans_S_B_S_N\">\n <h2 class=\"title topictitle2\" id=\"title_RTETrans-RTETrans_S_B_S_N\">RTETransformer - RTETransformer(String transformDefinitionId, Boolean verboseLogging,\n String source, Number batchSize)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Instantiates an RTETransformer object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\">transformDefinitionId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\">Sys_id of the extract, transform, and load (ETL) definition to use for the\n transform. Located in the ETL Definitions [sys_rte_eb_etl_definition] table.<p class=\"p\">For\n information on creating an ETL, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RTETransformer/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-etl-definitions&version=vancouver&pubname=vancouver-integrate-applications\" class=\"xref\">Create Extract Transform\n Load (ETL) definitions</a>.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\">verboseLogging</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\"><p class=\"p\">Flag that indicates whether to enable verbose logging and the creation of import\n set rows for debugging.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"RTETrans-RTETrans_S_B_S_N__ul_u1v_fm2_jtb\">\n <li class=\"li\">true: Enable logging and import set row creation.</li>\n <li class=\"li\">false: Do not enable logging and import set row creation.</li>\n </ul></div></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\">source</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\">Name field of the import set record.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\">batchSize</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\">Number of messages to process at one time (batch). For example, if there are 10\n messages in a payload, and this value is set to 2, the method runs five separate\n batch jobs to process all messages in the payload.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following code example shows how to instantiate an RTETransformer object for the source\n testSourceRecord that has a batch size of 10.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \n // Uses an ETL definition with a target table of incident, and mappings for the number and short description field\n var transformer = new sn_impex.RTETransformer("c58f1c6377110110f5455d14cd5a998b", true, "testSourceRecord", 10);\n var messages = ["{\\"number\\":\\"testnumber\\",\\"short_description\\":\\"testdesc\\"}"];\n var results = transformer.transform(messages);\n\n for (var i = 0; i < results.length; i++) {\n var dataList = results[i].data.incident;\n gs.log("source record id: " + results[i].sourceRecordSysId);\n gs.log("status: " + results[i].status);\n for (var j = 0; j < dataList.length; j++) {\n gs.log("number:" + dataList[j].number);\n gs.log("short desc:" + dataList[j].short_description);\n }\n }\n})(request, response, ctx);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RTETrans-transform_A\" id=\"RTETrans-transform_A\">\n <h2 class=\"title topictitle2\" id=\"title_RTETrans-transform_A\">RTETransformer - transform(Array message)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Transforms and stores an array of messages into a record in the associated <span class=\"ph\">ServiceNow</span> instance based on a provided extract, transform, and load (ETL)\n definition.</p>\n <section class=\"section\">\n <p class=\"p\">For example, if you want to transform user information into a sys_user record, you can\n create a message array with a single message and pass it into this transform method.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RTETrans-transform_A__table_xsb_bq2_jtb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__1\">message</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__2\">Array of Objects</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__3\">Stringified JSON objects representing the records to transform based on the ETL\n definition.<div class=\"p\">For example, if you want to transform a single user with the data\n active, email, first name, and last name to the sys_user table, the message would\n look similar to this: <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n { \n "active":"true",\n "email":"example@servicenow.com",\n "first_name":"Jane",\n "last_name":"Doe" \n }\n]</code></pre>\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> The field names must match the field/path of the source entity\n fields.</div></div></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RTETrans-transform_A__table_ysb_bq2_jtb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">data</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">Data for the transformed records, organized by table name. The returned record\n data matches the mapped fields specified in the ETL definition.<p class=\"p\">Data type:\n Object</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"data": {\n "tableName": []\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">data.tableName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">Details of the table containing the records.<p class=\"p\">Data type: Array of\n Objects</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"tableName": [{\n "sys_id": String,\n // Other data for a single transformed record\n }]\n}</code></pre>\n <div class=\"p\">For example:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"sys_user": [{ \n "sys_id":"b29e629877130110f5455d14cd5a99ad",\n "active": "true",\n "email": "example@servicenow.com",\n "first_name": "Jane",\n "last_name": "Doe"\n}]</code></pre></div></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">data.tableName.sys_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">Sys_id of the record within the table.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">data.tableName.<other_ETL_info></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">Additional fields that were specified in the passed ETL.<p class=\"p\">Data type:\n Any</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">message</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">If an error occurs while transforming the specified record, a message that\n describes the error. Null if the transform is successful.<p class=\"p\">Data type:\n String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">sourceRecordSysId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">Sys_id of the import set table record. The import set table name is JSON Event\n Sink [imp_json_event_sink].<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\">status</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\">Status of the transform, such as processed or error.<p class=\"p\">Data type:\n String</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following code example shows how to transform and store a record in the User [sys_user]\n table.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \n // Uses an ETL definition with a target table of sys_user, and mappings for the active, \n //email, first name, and last name fields\n var transformer = new sn_impex.RTETransformer("c58f1c6377110110f5455d14cd5a998b", true, "testSourceRecord", 10);\n var messages = [JSON.stringify({\n "active":"true",\n "email":"example@servicenow.com",\n "first_name":"Jane",\n "last_name":"Doe"\n }), \n JSON.stringify({\n "active":"true",\n "email":"example2@servicenow.com",\n "first_name":"John",\n "last_name":"Deer"\n })];\n var results = transformer.transform(messages);\n\n for (var i = 0; i < results.length; i++) { \n var dataList = results[i].data.sys_user;\n gs.log("source record id: " + results[i].sourceRecordSysId); gs.log("status: " + results[i].status);\n for (var j = 0; j < dataList.length; j++) { \n gs.log("First Name: " + dataList[j].first_name);\n gs.log("Last Name: " + dataList[j].last_name);\n gs.log("Email: " + dataList[j].email;\n gs.log("Active: " + dataList[j].active;\n }\n }\n}</code></pre>\n <p class=\"p\">Results:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">source record id: b29e629877130110f5455d14cd5a99ad\nstatus: PROCESSED\nFirst Name: Jane\nLast Name: Doe\nEmail: example@servicenow.com\nActive: true\nFirst Name: John\nLast Name: Deer\nEmail: example2@servicenow.com\nActive: true</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RTETransformer - Scoped</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206665\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206665\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"RTETransScopedAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RTETransformer API provides a method to transform and store an array of messages into a record in the associated ServiceNow instance based on a provided extract, transform, and load (ETL) definition.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\",\n \"page_key\": 41206665,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 6349,\n \"img_count\": 0,\n \"read_time\": 3,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 777\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RTETransformer - Scoped\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_RTETransScopedAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_RTETransScopedAPI\\\" id=\\\"RTETransScopedAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_RTETransScopedAPI\\\">RTETransformer<span class=\\\"ph\\\"> - Scoped</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RTETransformer</span> API provides a method to transform and store an\\n array of messages into a record in the associated <span class=\\\"ph\\\">ServiceNow</span> instance\\n based on a provided extract, transform, and load (ETL) definition.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">For example, use this API when you have JSON payload(s) that contain user information and\\n you want to transform that information into the sys_user table using the Robust Transform\\n Engine (RTE).</p>\\n <p class=\\\"p\\\">Use the <code class=\\\"ph codeph\\\">sn_impex</code> namespace when accessing this API.</p>\\n <p class=\\\"p\\\">For additional information, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RTETransformer/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=define-rte-operations&version=vancouver&pubname=vancouver-integrate-applications\\\" class=\\\"xref\\\">Define Robust Transform Engine\\n operations</a>.</p>\\n </section>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_RTETrans-RTETrans_S_B_S_N\\\" id=\\\"RTETrans-RTETrans_S_B_S_N\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RTETrans-RTETrans_S_B_S_N\\\">RTETransformer - RTETransformer(String transformDefinitionId, Boolean verboseLogging,\\n String source, Number batchSize)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Instantiates an RTETransformer object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\\\">transformDefinitionId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\\\">Sys_id of the extract, transform, and load (ETL) definition to use for the\\n transform. Located in the ETL Definitions [sys_rte_eb_etl_definition] table.<p class=\\\"p\\\">For\\n information on creating an ETL, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RTETransformer/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-etl-definitions&version=vancouver&pubname=vancouver-integrate-applications\\\" class=\\\"xref\\\">Create Extract Transform\\n Load (ETL) definitions</a>.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\\\">verboseLogging</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\\\"><p class=\\\"p\\\">Flag that indicates whether to enable verbose logging and the creation of import\\n set rows for debugging.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"RTETrans-RTETrans_S_B_S_N__ul_u1v_fm2_jtb\\\">\\n <li class=\\\"li\\\">true: Enable logging and import set row creation.</li>\\n <li class=\\\"li\\\">false: Do not enable logging and import set row creation.</li>\\n </ul></div></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\\\">source</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\\\">Name field of the import set record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__1\\\">batchSize</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-RTETrans_S_B_S_N__table_rsd_fk2_jtb__entry__3\\\">Number of messages to process at one time (batch). For example, if there are 10\\n messages in a payload, and this value is set to 2, the method runs five separate\\n batch jobs to process all messages in the payload.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following code example shows how to instantiate an RTETransformer object for the source\\n testSourceRecord that has a batch size of 10.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \\n // Uses an ETL definition with a target table of incident, and mappings for the number and short description field\\n var transformer = new sn_impex.RTETransformer("c58f1c6377110110f5455d14cd5a998b", true, "testSourceRecord", 10);\\n var messages = ["{\\\\"number\\\\":\\\\"testnumber\\\\",\\\\"short_description\\\\":\\\\"testdesc\\\\"}"];\\n var results = transformer.transform(messages);\\n\\n for (var i = 0; i < results.length; i++) {\\n var dataList = results[i].data.incident;\\n gs.log("source record id: " + results[i].sourceRecordSysId);\\n gs.log("status: " + results[i].status);\\n for (var j = 0; j < dataList.length; j++) {\\n gs.log("number:" + dataList[j].number);\\n gs.log("short desc:" + dataList[j].short_description);\\n }\\n }\\n})(request, response, ctx);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RTETrans-transform_A\\\" id=\\\"RTETrans-transform_A\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RTETrans-transform_A\\\">RTETransformer - transform(Array message)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Transforms and stores an array of messages into a record in the associated <span class=\\\"ph\\\">ServiceNow</span> instance based on a provided extract, transform, and load (ETL)\\n definition.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">For example, if you want to transform user information into a sys_user record, you can\\n create a message array with a single message and pass it into this transform method.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RTETrans-transform_A__table_xsb_bq2_jtb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__1\\\">message</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__2\\\">Array of Objects</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_xsb_bq2_jtb__entry__3\\\">Stringified JSON objects representing the records to transform based on the ETL\\n definition.<div class=\\\"p\\\">For example, if you want to transform a single user with the data\\n active, email, first name, and last name to the sys_user table, the message would\\n look similar to this: <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n { \\n "active":"true",\\n "email":"example@servicenow.com",\\n "first_name":"Jane",\\n "last_name":"Doe" \\n }\\n]</code></pre>\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> The field names must match the field/path of the source entity\\n fields.</div></div></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RTETrans-transform_A__table_ysb_bq2_jtb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">data</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">Data for the transformed records, organized by table name. The returned record\\n data matches the mapped fields specified in the ETL definition.<p class=\\\"p\\\">Data type:\\n Object</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"data": {\\n "tableName": []\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">data.tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">Details of the table containing the records.<p class=\\\"p\\\">Data type: Array of\\n Objects</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"tableName": [{\\n "sys_id": String,\\n // Other data for a single transformed record\\n }]\\n}</code></pre>\\n <div class=\\\"p\\\">For example:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"sys_user": [{ \\n "sys_id":"b29e629877130110f5455d14cd5a99ad",\\n "active": "true",\\n "email": "example@servicenow.com",\\n "first_name": "Jane",\\n "last_name": "Doe"\\n}]</code></pre></div></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">data.tableName.sys_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">Sys_id of the record within the table.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">data.tableName.<other_ETL_info></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">Additional fields that were specified in the passed ETL.<p class=\\\"p\\\">Data type:\\n Any</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">message</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">If an error occurs while transforming the specified record, a message that\\n describes the error. Null if the transform is successful.<p class=\\\"p\\\">Data type:\\n String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">sourceRecordSysId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">Sys_id of the import set table record. The import set table name is JSON Event\\n Sink [imp_json_event_sink].<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__1\\\">status</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RTETrans-transform_A__table_ysb_bq2_jtb__entry__2\\\">Status of the transform, such as processed or error.<p class=\\\"p\\\">Data type:\\n String</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following code example shows how to transform and store a record in the User [sys_user]\\n table.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \\n // Uses an ETL definition with a target table of sys_user, and mappings for the active, \\n //email, first name, and last name fields\\n var transformer = new sn_impex.RTETransformer("c58f1c6377110110f5455d14cd5a998b", true, "testSourceRecord", 10);\\n var messages = [JSON.stringify({\\n "active":"true",\\n "email":"example@servicenow.com",\\n "first_name":"Jane",\\n "last_name":"Doe"\\n }), \\n JSON.stringify({\\n "active":"true",\\n "email":"example2@servicenow.com",\\n "first_name":"John",\\n "last_name":"Deer"\\n })];\\n var results = transformer.transform(messages);\\n\\n for (var i = 0; i < results.length; i++) { \\n var dataList = results[i].data.sys_user;\\n gs.log("source record id: " + results[i].sourceRecordSysId); gs.log("status: " + results[i].status);\\n for (var j = 0; j < dataList.length; j++) { \\n gs.log("First Name: " + dataList[j].first_name);\\n gs.log("Last Name: " + dataList[j].last_name);\\n gs.log("Email: " + dataList[j].email;\\n gs.log("Active: " + dataList[j].active;\\n }\\n }\\n}</code></pre>\\n <p class=\\\"p\\\">Results:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">source record id: b29e629877130110f5455d14cd5a99ad\\nstatus: PROCESSED\\nFirst Name: Jane\\nLast Name: Doe\\nEmail: example@servicenow.com\\nActive: true\\nFirst Name: John\\nLast Name: Deer\\nEmail: example2@servicenow.com\\nActive: true</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RTETransformer - Scoped\n\nThe RTETransformer API provides a method to transform and store an\narray of messages into a record in the associated ServiceNow instance\nbased on a provided extract, transform, and load (ETL) definition.\n\nFor example, use this API when you have JSON payload(s) that contain user information and\nyou want to transform that information into the sys\\_user table using the Robust Transform\nEngine (RTE).\n\nUse the `sn_impex` namespace when accessing this API.\n\nFor additional information, see Define Robust Transform Engine\noperations.\n\n## RTETransformer - RTETransformer(String transformDefinitionId, Boolean verboseLogging, String source, Number batchSize)\n\nInstantiates an RTETransformer object.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| transformDefinitionId | String | Sys\\_id of the extract, transform, and load (ETL) definition to use for the transform. Located in the ETL Definitions [sys\\_rte\\_eb\\_etl\\_definition] table. For information on creating an ETL, see Create Extract Transform Load (ETL) definitions. |\n| verboseLogging | Boolean | Flag that indicates whether to enable verbose logging and the creation of import set rows for debugging. Valid values: * true: Enable logging and import set row creation. * false: Do not enable logging and import set row creation. |\n| source | String | Name field of the import set record. |\n| batchSize | Number | Number of messages to process at one time (batch). For example, if there are 10 messages in a payload, and this value is set to 2, the method runs five separate batch jobs to process all messages in the payload. |\n\n### Example\n\nThe following code example shows how to instantiate an RTETransformer object for the source\ntestSourceRecord that has a batch size of 10.\n\n```None\n(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \n // Uses an ETL definition with a target table of incident, and mappings for the number and short description field\n var transformer = new sn_impex.RTETransformer(\"c58f1c6377110110f5455d14cd5a998b\", true, \"testSourceRecord\", 10);\n var messages = [\"{\\\"number\\\":\\\"testnumber\\\",\\\"short_description\\\":\\\"testdesc\\\"}\"];\n var results = transformer.transform(messages);\n\n for (var i = 0; i < results.length; i++) {\n var dataList = results[i].data.incident;\n gs.log(\"source record id: \" + results[i].sourceRecordSysId);\n gs.log(\"status: \" + results[i].status);\n for (var j = 0; j < dataList.length; j++) {\n gs.log(\"number:\" + dataList[j].number);\n gs.log(\"short desc:\" + dataList[j].short_description);\n }\n }\n})(request, response, ctx);\n```\n\n## RTETransformer - transform(Array message)\n\nTransforms and stores an array of messages into a record in the associated ServiceNow instance based on a provided extract, transform, and load (ETL)\ndefinition.\n\nFor example, if you want to transform user information into a sys\\_user record, you can\ncreate a message array with a single message and pass it into this transform method.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| message | Array of Objects | Stringified JSON objects representing the records to transform based on the ETL definition.For example, if you want to transform a single user with the data active, email, first name, and last name to the sys\\_user table, the message would look similar to this: ```None [ { \"active\":\"true\", \"email\":\"example@servicenow.com\", \"first_name\":\"Jane\", \"last_name\":\"Doe\" } ] ``` Note: The field names must match the field/path of the source entity fields. |\n\nTable 3. Returns\n| Name | Description |\n| --- | --- |\n| data | Data for the transformed records, organized by table name. The returned record data matches the mapped fields specified in the ETL definition. Data type: Object ```None \"data\": { \"tableName\": [] } ``` |\n| data.tableName | Details of the table containing the records. Data type: Array of Objects ```None \"tableName\": [{ \"sys_id\": String, // Other data for a single transformed record }] } ``` For example: ```None \"sys_user\": [{ \"sys_id\":\"b29e629877130110f5455d14cd5a99ad\", \"active\": \"true\", \"email\": \"example@servicenow.com\", \"first_name\": \"Jane\", \"last_name\": \"Doe\" }] ``` |\n| data.tableName.sys\\_id | Sys\\_id of the record within the table. Data type: String |\n| data.tableName.<other\\_ETL\\_info> | Additional fields that were specified in the passed ETL. Data type: Any |\n| message | If an error occurs while transforming the specified record, a message that describes the error. Null if the transform is successful. Data type: String |\n| sourceRecordSysId | Sys\\_id of the import set table record. The import set table name is JSON Event Sink [imp\\_json\\_event\\_sink]. Data type: String |\n| status | Status of the transform, such as processed or error. Data type: String |\n\n### Example\n\nThe following code example shows how to transform and store a record in the User [sys\\_user]\ntable.\n\n```None\n(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \n // Uses an ETL definition with a target table of sys_user, and mappings for the active, \n //email, first name, and last name fields\n var transformer = new sn_impex.RTETransformer(\"c58f1c6377110110f5455d14cd5a998b\", true, \"testSourceRecord\", 10);\n var messages = [JSON.stringify({\n \"active\":\"true\",\n \"email\":\"example@servicenow.com\",\n \"first_name\":\"Jane\",\n \"last_name\":\"Doe\"\n }), \n JSON.stringify({\n \"active\":\"true\",\n \"email\":\"example2@servicenow.com\",\n \"first_name\":\"John\",\n \"last_name\":\"Deer\"\n })];\n var results = transformer.transform(messages);\n\n for (var i = 0; i < results.length; i++) { \n var dataList = results[i].data.sys_user;\n gs.log(\"source record id: \" + results[i].sourceRecordSysId); gs.log(\"status: \" + results[i].status);\n for (var j = 0; j < dataList.length; j++) { \n gs.log(\"First Name: \" + dataList[j].first_name);\n gs.log(\"Last Name: \" + dataList[j].last_name);\n gs.log(\"Email: \" + dataList[j].email;\n gs.log(\"Active: \" + dataList[j].active;\n }\n }\n}\n```\n\nResults:\n\n```None\nsource record id: b29e629877130110f5455d14cd5a99ad\nstatus: PROCESSED\nFirst Name: Jane\nLast Name: Doe\nEmail: example@servicenow.com\nActive: true\nFirst Name: John\nLast Name: Deer\nEmail: example2@servicenow.com\nActive: true\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RTETransformer - Scoped\ndescription: The RTETransformer API provides a method to transform and store an array\n of messages into a record in the associated ServiceNow instance based on a provided\n extract, transform, and load (ETL) definition.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RTETransformer - Scoped\n\nThe RTETransformer API provides a method to transform and store an\narray of messages into a record in the associated ServiceNow instance\nbased on a provided extract, transform, and load (ETL) definition.\n\nFor example, use this API when you have JSON payload(s) that contain user information and\nyou want to transform that information into the sys\\_user table using the Robust Transform\nEngine (RTE).\n\nUse the `sn_impex` namespace when accessing this API.\n\nFor additional information, see Define Robust Transform Engine\noperations.\n\n## RTETransformer - RTETransformer(String transformDefinitionId, Boolean verboseLogging, String source, Number batchSize)\n\nInstantiates an RTETransformer object.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| transformDefinitionId | String | Sys\\_id of the extract, transform, and load (ETL) definition to use for the transform. Located in the ETL Definitions [sys\\_rte\\_eb\\_etl\\_definition] table. For information on creating an ETL, see Create Extract Transform Load (ETL) definitions. |\n| verboseLogging | Boolean | Flag that indicates whether to enable verbose logging and the creation of import set rows for debugging. Valid values: * true: Enable logging and import set row creation. * false: Do not enable logging and import set row creation. |\n| source | String | Name field of the import set record. |\n| batchSize | Number | Number of messages to process at one time (batch). For example, if there are 10 messages in a payload, and this value is set to 2, the method runs five separate batch jobs to process all messages in the payload. |\n\n### Example\n\nThe following code example shows how to instantiate an RTETransformer object for the source\ntestSourceRecord that has a batch size of 10.\n\n```None\n(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \n // Uses an ETL definition with a target table of incident, and mappings for the number and short description field\n var transformer = new sn_impex.RTETransformer(\"c58f1c6377110110f5455d14cd5a998b\", true, \"testSourceRecord\", 10);\n var messages = [\"{\\\"number\\\":\\\"testnumber\\\",\\\"short_description\\\":\\\"testdesc\\\"}\"];\n var results = transformer.transform(messages);\n\n for (var i = 0; i < results.length; i++) {\n var dataList = results[i].data.incident;\n gs.log(\"source record id: \" + results[i].sourceRecordSysId);\n gs.log(\"status: \" + results[i].status);\n for (var j = 0; j < dataList.length; j++) {\n gs.log(\"number:\" + dataList[j].number);\n gs.log(\"short desc:\" + dataList[j].short_description);\n }\n }\n})(request, response, ctx);\n```\n\n## RTETransformer - transform(Array message)\n\nTransforms and stores an array of messages into a record in the associated ServiceNow instance based on a provided extract, transform, and load (ETL)\ndefinition.\n\nFor example, if you want to transform user information into a sys\\_user record, you can\ncreate a message array with a single message and pass it into this transform method.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| message | Array of Objects | Stringified JSON objects representing the records to transform based on the ETL definition.For example, if you want to transform a single user with the data active, email, first name, and last name to the sys\\_user table, the message would look similar to this: ```None [ { \"active\":\"true\", \"email\":\"example@servicenow.com\", \"first_name\":\"Jane\", \"last_name\":\"Doe\" } ] ``` Note: The field names must match the field/path of the source entity fields. |\n\nTable 3. Returns\n| Name | Description |\n| --- | --- |\n| data | Data for the transformed records, organized by table name. The returned record data matches the mapped fields specified in the ETL definition. Data type: Object ```None \"data\": { \"tableName\": [] } ``` |\n| data.tableName | Details of the table containing the records. Data type: Array of Objects ```None \"tableName\": [{ \"sys_id\": String, // Other data for a single transformed record }] } ``` For example: ```None \"sys_user\": [{ \"sys_id\":\"b29e629877130110f5455d14cd5a99ad\", \"active\": \"true\", \"email\": \"example@servicenow.com\", \"first_name\": \"Jane\", \"last_name\": \"Doe\" }] ``` |\n| data.tableName.sys\\_id | Sys\\_id of the record within the table. Data type: String |\n| data.tableName.<other\\_ETL\\_info> | Additional fields that were specified in the passed ETL. Data type: Any |\n| message | If an error occurs while transforming the specified record, a message that describes the error. Null if the transform is successful. Data type: String |\n| sourceRecordSysId | Sys\\_id of the import set table record. The import set table name is JSON Event Sink [imp\\_json\\_event\\_sink]. Data type: String |\n| status | Status of the transform, such as processed or error. Data type: String |\n\n### Example\n\nThe following code example shows how to transform and store a record in the User [sys\\_user]\ntable.\n\n```None\n(function(/*CTIOperationRequest*/ request, /*CTIOperationResponse*/ response, /*Context*/ ctx) { \n // Uses an ETL definition with a target table of sys_user, and mappings for the active, \n //email, first name, and last name fields\n var transformer = new sn_impex.RTETransformer(\"c58f1c6377110110f5455d14cd5a998b\", true, \"testSourceRecord\", 10);\n var messages = [JSON.stringify({\n \"active\":\"true\",\n \"email\":\"example@servicenow.com\",\n \"first_name\":\"Jane\",\n \"last_name\":\"Doe\"\n }), \n JSON.stringify({\n \"active\":\"true\",\n \"email\":\"example2@servicenow.com\",\n \"first_name\":\"John\",\n \"last_name\":\"Deer\"\n })];\n var results = transformer.transform(messages);\n\n for (var i = 0; i < results.length; i++) { \n var dataList = results[i].data.sys_user;\n gs.log(\"source record id: \" + results[i].sourceRecordSysId); gs.log(\"status: \" + results[i].status);\n for (var j = 0; j < dataList.length; j++) { \n gs.log(\"First Name: \" + dataList[j].first_name);\n gs.log(\"Last Name: \" + dataList[j].last_name);\n gs.log(\"Email: \" + dataList[j].email;\n gs.log(\"Active: \" + dataList[j].active;\n }\n }\n}\n```\n\nResults:\n\n```None\nsource record id: b29e629877130110f5455d14cd5a99ad\nstatus: PROCESSED\nFirst Name: Jane\nLast Name: Doe\nEmail: example@servicenow.com\nActive: true\nFirst Name: John\nLast Name: Deer\nEmail: example2@servicenow.com\nActive: true\n```\n"}}},{"rowIdx":1993,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RecordToHTML - Global"},"description":{"kind":"string","value":"The RecordToHTML API is a utility class to turn a record into HTML."},"keywords":{"kind":"list like","value":["RecordToHTML API","RecordToHTML","RecordToHTML(String table","String sys_id","String pattern","Boolean link)","setValue(String fieldName","String value)","toString()"],"string":"[\n \"RecordToHTML API\",\n \"RecordToHTML\",\n \"RecordToHTML(String table\",\n \"String sys_id\",\n \"String pattern\",\n \"Boolean link)\",\n \"setValue(String fieldName\",\n \"String value)\",\n \"toString()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_c_RecordToHTMLAPI\"><article class=\"nested0\" aria-labelledby=\"title_c_RecordToHTMLAPI\" id=\"c_RecordToHTMLAPI\">\n <h1 class=\"title topictitle1\" id=\"title_c_RecordToHTMLAPI\">RecordToHTML<span class=\"ph\"> - Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RecordToHTML</span> API is a utility class to turn a record into\n HTML.</p>\n <p class=\"p\">This API is available to server-side scripts.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_r_RTH-RecordToHTML_S_S_S_B\" id=\"r_RTH-RecordToHTML_S_S_S_B\">\n <h2 class=\"title topictitle2\" id=\"title_r_RTH-RecordToHTML_S_S_S_B\">RecordToHTML - RecordToHTML(String table, String sys_id, String pattern, Boolean\n link)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Creates an instance of a <span class=\"keyword apiname\">RecordToHTML</span> class.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\">table</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\">Table name of the record.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\">sys_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\">Sys_id of the record.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\">pattern</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\">The pattern of the string to generate. The pattern can include ${} template literals to provide the content of existing field values. For example, the pattern "${number}" provides the number for the selected\n record.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\">link</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\">Flag that indicates whether generate results as an HTML link.<div class=\"p\">Valid values:<ul class=\"ul\" id=\"r_RTH-RecordToHTML_S_S_S_B__ul_t3q_zcc_rwb\">\n <li class=\"li\">true: The record information is generated as a link in an HTML tag.</li>\n <li class=\"li\">false: The record information is generated as text.</li>\n </ul></div><p class=\"p\">Default: False</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to generate formatted incident record information in an HTML link.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var r2html = new RecordToHTML("incident", "e8e875b0c0a80164009dc852b4d677d5",\n"incident: ${number}-${short_description}");\ngs.print(r2html.toString());</code></pre>\n <div class=\"p\">Output:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\"><a href="incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a>\n</code></pre></div>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RTH-setValue_S_S\" id=\"r_RTH-setValue_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_RTH-setValue_S_S\">RecordToHTML - setValue(String fieldName, String value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the specified field to the specified value.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RTH-setValue_S_S__table_uh3_chv_4t\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__1\">fieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__3\">Name of the field to change.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__3\">Value to set the field to.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RTH-setValue_S_S__table_vh3_chv_4t\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <div class=\"p\">The following example shows how to generate formatted incident record information including the user name as a\n string.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var r2html = new RecordToHTML("incident","e8e875b0c0a80164009dc852b4d677d5", "incident: ${number}-${short_description} (${user})", true);\nr2html.setValue("user", gs.getUserName());\ngs.print(r2html.toString());</code></pre></div>\n <div class=\"p\">Output:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">incident: INC0000005-CPU load high for over 10 minutes (admin)</code></pre></div>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_RTH-toString\" id=\"r_RTH-toString\">\n <h2 class=\"title topictitle2\" id=\"title_r_RTH-toString\">RecordToHTML - toString()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Converts a RecordToHTML object to a string.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_RTH-toString__table_gtj_phv_4t\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-toString__table_gtj_phv_4t__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-toString__table_gtj_phv_4t__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-toString__table_gtj_phv_4t__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-toString__table_gtj_phv_4t__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-toString__table_gtj_phv_4t__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-toString__table_gtj_phv_4t__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_RTH-toString__table_htj_phv_4t\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-toString__table_htj_phv_4t__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_RTH-toString__table_htj_phv_4t__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-toString__table_htj_phv_4t__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_RTH-toString__table_htj_phv_4t__entry__2\">HTML output of the record in the pattern set using the <span class=\"keyword apiname\">RecordToHTML()</span> constructor.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to convert a <span class=\"keyword apiname\">RecordToHTML</span> object to a string and display the results.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var r2html = new RecordToHTML("incident","e8e875b0c0a80164009dc852b4d677d5", \n "incident: ${number}-${short_description}", true);\ngs.print(r2html.toString());</code></pre>\n <div class=\"p\">Output:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\"><a href="incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a></code></pre></div>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RecordToHTML - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206668\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206668\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"c_RecordToHTMLAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"RecordToHTML API,RecordToHTML,RecordToHTML(String table, String sys_id, String pattern, Boolean link),setValue(String fieldName, String value),toString()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RecordToHTML API is a utility class to turn a record into HTML.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"RecordToHTML API, RecordToHTML, RecordToHTML(String table, String sys_id, String pattern, Boolean link), setValue(String fieldName, String value), toString()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\",\n \"page_key\": 41206668,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 2461,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 297\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RecordToHTML - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_c_RecordToHTMLAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_c_RecordToHTMLAPI\\\" id=\\\"c_RecordToHTMLAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_c_RecordToHTMLAPI\\\">RecordToHTML<span class=\\\"ph\\\"> - Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RecordToHTML</span> API is a utility class to turn a record into\\n HTML.</p>\\n <p class=\\\"p\\\">This API is available to server-side scripts.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_r_RTH-RecordToHTML_S_S_S_B\\\" id=\\\"r_RTH-RecordToHTML_S_S_S_B\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RTH-RecordToHTML_S_S_S_B\\\">RecordToHTML - RecordToHTML(String table, String sys_id, String pattern, Boolean\\n link)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Creates an instance of a <span class=\\\"keyword apiname\\\">RecordToHTML</span> class.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\\\">table</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\\\">Table name of the record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\\\">sys_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\\\">Sys_id of the record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\\\">pattern</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\\\">The pattern of the string to generate. The pattern can include ${} template literals to provide the content of existing field values. For example, the pattern "${number}" provides the number for the selected\\n record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__1\\\">link</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-RecordToHTML_S_S_S_B__table_zdx_h3v_4t__entry__3\\\">Flag that indicates whether generate results as an HTML link.<div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"r_RTH-RecordToHTML_S_S_S_B__ul_t3q_zcc_rwb\\\">\\n <li class=\\\"li\\\">true: The record information is generated as a link in an HTML tag.</li>\\n <li class=\\\"li\\\">false: The record information is generated as text.</li>\\n </ul></div><p class=\\\"p\\\">Default: False</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to generate formatted incident record information in an HTML link.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var r2html = new RecordToHTML("incident", "e8e875b0c0a80164009dc852b4d677d5",\\n"incident: ${number}-${short_description}");\\ngs.print(r2html.toString());</code></pre>\\n <div class=\\\"p\\\">Output:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\"><a href="incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a>\\n</code></pre></div>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RTH-setValue_S_S\\\" id=\\\"r_RTH-setValue_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RTH-setValue_S_S\\\">RecordToHTML - setValue(String fieldName, String value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the specified field to the specified value.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__1\\\">fieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__3\\\">Name of the field to change.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_uh3_chv_4t__entry__3\\\">Value to set the field to.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RTH-setValue_S_S__table_vh3_chv_4t\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-setValue_S_S__table_vh3_chv_4t__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <div class=\\\"p\\\">The following example shows how to generate formatted incident record information including the user name as a\\n string.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var r2html = new RecordToHTML("incident","e8e875b0c0a80164009dc852b4d677d5", "incident: ${number}-${short_description} (${user})", true);\\nr2html.setValue("user", gs.getUserName());\\ngs.print(r2html.toString());</code></pre></div>\\n <div class=\\\"p\\\">Output:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">incident: INC0000005-CPU load high for over 10 minutes (admin)</code></pre></div>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_RTH-toString\\\" id=\\\"r_RTH-toString\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_RTH-toString\\\">RecordToHTML - toString()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Converts a RecordToHTML object to a string.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_RTH-toString__table_gtj_phv_4t\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-toString__table_gtj_phv_4t__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-toString__table_gtj_phv_4t__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-toString__table_gtj_phv_4t__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-toString__table_gtj_phv_4t__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-toString__table_gtj_phv_4t__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-toString__table_gtj_phv_4t__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_RTH-toString__table_htj_phv_4t\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-toString__table_htj_phv_4t__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_RTH-toString__table_htj_phv_4t__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-toString__table_htj_phv_4t__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_RTH-toString__table_htj_phv_4t__entry__2\\\">HTML output of the record in the pattern set using the <span class=\\\"keyword apiname\\\">RecordToHTML()</span> constructor.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to convert a <span class=\\\"keyword apiname\\\">RecordToHTML</span> object to a string and display the results.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var r2html = new RecordToHTML("incident","e8e875b0c0a80164009dc852b4d677d5", \\n "incident: ${number}-${short_description}", true);\\ngs.print(r2html.toString());</code></pre>\\n <div class=\\\"p\\\">Output:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\"><a href="incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a></code></pre></div>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RecordToHTML - Global\n\nThe RecordToHTML API is a utility class to turn a record into\nHTML.\n\nThis API is available to server-side scripts.\n\n## RecordToHTML - RecordToHTML(String table, String sys\\_id, String pattern, Boolean link)\n\nCreates an instance of a RecordToHTML class.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| table | String | Table name of the record. |\n| sys\\_id | String | Sys\\_id of the record. |\n| pattern | String | The pattern of the string to generate. The pattern can include ${} template literals to provide the content of existing field values. For example, the pattern \"${number}\" provides the number for the selected record. |\n| link | Boolean | Flag that indicates whether generate results as an HTML link.Valid values: * true: The record information is generated as a link in an HTML tag. * false: The record information is generated as text. Default: False |\n\n### Example\n\nThe following example shows how to generate formatted incident record information in an HTML link.\n\n```None\nvar r2html = new RecordToHTML(\"incident\", \"e8e875b0c0a80164009dc852b4d677d5\",\n\"incident: ${number}-${short_description}\");\ngs.print(r2html.toString());\n```\nOutput:\n```None\n<a href=\"incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5\"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a>\n\n```\n\n## RecordToHTML - setValue(String fieldName, String value)\n\nSets the specified field to the specified value.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| fieldName | String | Name of the field to change. |\n| value | String | Value to set the field to. |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to generate formatted incident record information including the user name as a\nstring.\n```None\nvar r2html = new RecordToHTML(\"incident\",\"e8e875b0c0a80164009dc852b4d677d5\", \"incident: ${number}-${short_description} (${user})\", true);\nr2html.setValue(\"user\", gs.getUserName());\ngs.print(r2html.toString());\n```\n\nOutput:\n```None\nincident: INC0000005-CPU load high for over 10 minutes (admin)\n```\n\n## RecordToHTML - toString()\n\nConverts a RecordToHTML object to a string.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| String | HTML output of the record in the pattern set using the RecordToHTML() constructor. |\n\n### Example\n\nThe following example shows how to convert a RecordToHTML object to a string and display the results.\n\n```None\nvar r2html = new RecordToHTML(\"incident\",\"e8e875b0c0a80164009dc852b4d677d5\", \n \"incident: ${number}-${short_description}\", true);\ngs.print(r2html.toString());\n```\nOutput:\n```None\n<a href=\"incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5\"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a>\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RecordToHTML - Global\ndescription: The RecordToHTML API is a utility class to turn a record into HTML.\nkeywords:\n- RecordToHTML API\n- RecordToHTML\n- RecordToHTML(String table\n- String sys_id\n- String pattern\n- Boolean link)\n- setValue(String fieldName\n- String value)\n- toString()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RecordToHTML - Global\n\nThe RecordToHTML API is a utility class to turn a record into\nHTML.\n\nThis API is available to server-side scripts.\n\n## RecordToHTML - RecordToHTML(String table, String sys\\_id, String pattern, Boolean link)\n\nCreates an instance of a RecordToHTML class.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| table | String | Table name of the record. |\n| sys\\_id | String | Sys\\_id of the record. |\n| pattern | String | The pattern of the string to generate. The pattern can include ${} template literals to provide the content of existing field values. For example, the pattern \"${number}\" provides the number for the selected record. |\n| link | Boolean | Flag that indicates whether generate results as an HTML link.Valid values: * true: The record information is generated as a link in an HTML tag. * false: The record information is generated as text. Default: False |\n\n### Example\n\nThe following example shows how to generate formatted incident record information in an HTML link.\n\n```None\nvar r2html = new RecordToHTML(\"incident\", \"e8e875b0c0a80164009dc852b4d677d5\",\n\"incident: ${number}-${short_description}\");\ngs.print(r2html.toString());\n```\nOutput:\n```None\n<a href=\"incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5\"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a>\n\n```\n\n## RecordToHTML - setValue(String fieldName, String value)\n\nSets the specified field to the specified value.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| fieldName | String | Name of the field to change. |\n| value | String | Value to set the field to. |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to generate formatted incident record information including the user name as a\nstring.\n```None\nvar r2html = new RecordToHTML(\"incident\",\"e8e875b0c0a80164009dc852b4d677d5\", \"incident: ${number}-${short_description} (${user})\", true);\nr2html.setValue(\"user\", gs.getUserName());\ngs.print(r2html.toString());\n```\n\nOutput:\n```None\nincident: INC0000005-CPU load high for over 10 minutes (admin)\n```\n\n## RecordToHTML - toString()\n\nConverts a RecordToHTML object to a string.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| String | HTML output of the record in the pattern set using the RecordToHTML() constructor. |\n\n### Example\n\nThe following example shows how to convert a RecordToHTML object to a string and display the results.\n\n```None\nvar r2html = new RecordToHTML(\"incident\",\"e8e875b0c0a80164009dc852b4d677d5\", \n \"incident: ${number}-${short_description}\", true);\ngs.print(r2html.toString());\n```\nOutput:\n```None\n<a href=\"incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5\"><u>incident: INC0000005-CPU load high for over 10 minutes</u></a>\n```\n"}}},{"rowIdx":1994,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RegressionSolution - Global"},"description":{"kind":"string","value":"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_RegressionSolutionAPI\"><article class=\"nested0\" aria-labelledby=\"title_RegressionSolutionAPI\" id=\"RegressionSolutionAPI\">\n <h1 class=\"title topictitle1\" id=\"title_RegressionSolutionAPI\">RegressionSolution<span class=\"ph\"> - Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RegressionSolution</span> API is a scriptable object used in <span class=\"ph\">Predictive Intelligence</span> stores.</p>\n <p class=\"p\">This <span class=\"ph\"> API requires the <span class=\"ph\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\n within the <code class=\"ph codeph\">sn_ml</code> namespace.</span></p>\n <div class=\"p\">The solution setup-to-training flow is as follows:<ol class=\"ol\" id=\"RegressionSolutionAPI__ol_mmm_n1c_dmb\">\n <li class=\"li\">Create a dataset using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" class=\"xref\" title=\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\"><span class=\"keyword apiname\">DatasetDefinition</span></a> API.</li>\n <li class=\"li\">Optional. Build an encoder using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" class=\"xref\" title=\"Scriptable object used in Predictive Intelligence stores. This object converts input data into vectors of numbers, based on encoder-specific goals and configurations. Encoders can be used independently to run encodings, or can be configured as part of solutions to encode text columns.\"><span class=\"keyword apiname\">Encoder</span></a> API.</li>\n <li class=\"li\">Use the <a class=\"xref\" href=\"#RegressionSol-RegressionSolution_O\" title=\"Creates a regression solution.\">constructor</a> to create a regression solution object.</li>\n <li class=\"li\">Add the solution object to the regression solution store using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html#RegressionStore-add_O\" class=\"xref\" title=\"Adds a new solution object to the store and returns a unique name.\"><span class=\"keyword apiname\">RegressionSolutionStore - add()</span></a> method.</li>\n <li class=\"li\">Train the solution using the <a class=\"xref\" href=\"#RegressionSol-submitTrainingJob\" title=\"Submits a training job.\"><span class=\"keyword apiname\">submitTrainingJob()</span></a> method. This creates a version of the\n object that you can manage using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" class=\"xref\" title=\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolutionVersion</span></a> API.</li>\n <li class=\"li\">Get predictions using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html#RegressionVersion-predict_O_O\" class=\"xref\" title=\"Gets the input data for a prediction.\"><span class=\"keyword apiname\">RegressionSolutionVersion – predict()</span></a> method.</li>\n </ol>\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This API runs <span class=\"ph\" id=\"RegressionSolutionAPI__ml-api-access-comp\">with full\n privileges. To restrict user access, include an access control mechanism in the\n script.</span></div></div>\n <p class=\"p\">For usage guidelines, refer to <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=using-ml-apis&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Using ML APIs</a>.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_RegressionSol-RegressionSolution_O\" id=\"RegressionSol-RegressionSolution_O\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-RegressionSolution_O\">RegressionSolution - RegressionSolution(Object config)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Creates a regression solution.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:33.33333333333333%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:50%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">JavaScript object containing configuration\n properties of the </span>solution.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "algorithmConfig": {Object},\n "dataset": {Object},\n "domainName": "String",\n "encoder": {Object},\n "inputFieldNames": [Array],\n "label": "String",\n "minRowCount": "String",\n "predictedFieldName": "String",\n "predictedInterval": [Array],\n "processingLanguage": "String",\n "stopwords": [Array],\n "trainingFrequency": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.dataset</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" class=\"xref\" title=\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\"><span class=\"keyword apiname\">DatasetDefinition</span></a> name.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\">Optional. <span class=\"ph\" id=\"RegressionSol-RegressionSolution_O__solution-obj-domainN-desc\">Domain name associated with this dataset. See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</span>\n <p class=\"p\" id=\"RegressionSol-RegressionSolution_O__solution-obj-domainN-default\">Default: Current domain, for example, <code class=\"ph codeph\">"global"</code>.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.encoder</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\">Optional. <span class=\"ph\">Trained encoder object to\n assign to this solution.</span> See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\" class=\"xref\" title=\"Creates an encoder.\">Encoder - Encoder(Object config)</a>.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.inputFieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">List of input field names as strings. The\n model uses these fields used to make\n predictions.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">Identifies the prediction\n task.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.minRowCount</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\">Optional. Minimum number of records required in\n the dataset for training.<p class=\"p\">Default: 10000</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.predictedFieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\">Mandatory unless setting <span class=\"keyword parmname\">predictedInterval</span>. <span class=\"ph\">Identifies a field to be trained for\n predictability.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.predictedInterval</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\">Mandatory unless setting <span class=\"keyword parmname\">predictedFieldName</span>. Sets a range\n of fields to train your solution for confidence. Supports providing\n 2\n non-numeric date fields. For example, <code class=\"ph codeph\">'predictedInterval':\n ['sys_updated_on', 'sys_created_on']</code>.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.processingLanguage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\">Optional. <span class=\"ph\" id=\"RegressionSol-RegressionSolution_O__solution-obj-lang-desc\">Processing language in two-letter ISO 639-1 language code format.</span>\n <p class=\"p\">Default:\n "en"</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.stopwords</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\" id=\"RegressionSol-RegressionSolution_O__solution-obj-stop-desc\">Optional. Preset\n list of strings that the system automatically generates based on the\n <span class=\"keyword parmname\">language</span> property setting. For details, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create a custom stopwords\n list</a>.</span>\n <p class=\"p\">Default: English Stopwords</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\">config.trainingFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">The frequency to retrain the model.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"RegressionSol-RegressionSolution_O__ul_pmw_523_plb\">\n <li class=\"li\">every_30_days</li>\n <li class=\"li\">every_60_days</li>\n <li class=\"li\">every_90_days</li>\n <li class=\"li\">every_120_days</li>\n <li class=\"li\">every_180_days</li>\n <li class=\"li\">run_once</li>\n </ul>Default: run_once</div></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to create an object\n and add it to the</span> RegressionSolution store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var myNewData = new sn_ml.DatasetDefinition(\n { \n 'tableName' : 'incident', \n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'fieldDetails' : [\n {\n 'name' : 'category',\n 'type' : 'nominal'\n },\n {\n 'name' : 'short_description',\n 'type' : 'text'\n }], \n 'encodedQuery' : 'activeANYTHING'\n });\n\nvar mySimSolution = new sn_ml.SimilaritySolution({\n 'label': "my solution definition",\n 'dataset' : myNewData,\n 'predictedFieldName' : 'category',\n 'inputFieldNames': ['short_description']\n});\n\nvar mySimilarityName = sn_ml.SimilaritySolutionStore.add(mySimSolution);</code></pre>\n </div>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to create an object to train using the\n <span class=\"keyword parmname\">predictedInterval</span> property.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var myIncidentData = new sn_ml.DatasetDefinition({\n'tableName' : 'incident',\n'fieldNames' : ['short_description', 'sys_updated_on','sys_created_on'],\n'encodedQuery' : 'activeANYTHING'\n});\n \nvar mySolution = new sn_ml.RegressionSolution({\n'label': 'reg assinGroup',\n'dataset' : myIncidentData,\n'predictedInterval': ['sys_updated_on', 'sys_created_on'],\n'inputFieldNames': ['short_description']\n});\n \nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution)</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-cancelTrainingJob\" id=\"RegressionSol-cancelTrainingJob\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-cancelTrainingJob\">RegressionSolution - cancelTrainingJob()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Cancels a job for</span> a solution object <span class=\"ph\">that has been submitted for training.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to cancel an existing\n training job.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression');\n\nmySolution.cancelTrainingJob();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-getActiveVersion\" id=\"RegressionSol-getActiveVersion\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-getActiveVersion\">RegressionSolution - getActiveVersion()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the active</span>\n <span class=\"keyword apiname\">RegressionSolutionVersion</span> object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-getActiveVersion__table_tvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-getActiveVersion__table_uvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__2\">Active <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" class=\"xref\" title=\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolutionVersion</span></a> object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to get an\n active</span>\n <span class=\"keyword apiname\">RegressionSolution</span>\n <span class=\"ph\">version from the store and return its\n training status.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "solution_complete",\n "percentComplete": "100",\n "hasJobEnded": "true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-getAllVersions\" id=\"RegressionSol-getAllVersions\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-getAllVersions\">RegressionSolution - getAllVersions()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets all versions of</span> a <span class=\"keyword apiname\">RegressionSolution</span> object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-getAllVersions__table_tvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-getAllVersions__table_uvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__2\"><span class=\"ph\">Existing versions of a solution object.\n See also</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" class=\"xref\" title=\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolutionVersion</span></a> API.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get all <span class=\"keyword apiname\">RegressionSolution</span>\n version objects and call the <span class=\"keyword apiname\">getVersionNumber()</span> and\n <span class=\"keyword apiname\">getStatus()</span> solution version methods on them.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\nvar mlSolutionVersions = mlSolution.getAllVersions();\n\nfor (i = 0; i < mlSolutionVersions.length; i++) {\ngs.print("Version " + mlSolutionVersions[i].getVersionNumber() + " Status: " + mlSolutionVersions[i].getStatus() +"\\n");\n};</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Version 3 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\n\nVersion 2 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\n\nVersion 1 Status: {"state":"solution_cancelled","percentComplete":"0","hasJobEnded":"true"}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-getLatestVersion\" id=\"RegressionSol-getLatestVersion\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-getLatestVersion\">RegressionSolution - getLatestVersion()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the latest version of</span> a solution.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-getLatestVersion__table_tvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-getLatestVersion__table_uvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" class=\"xref\" title=\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolutionVersion</span></a>\n <span class=\"ph\"> object corresponding to the latest\n version of</span> a <a class=\"xref\" href=\"#RegressionSol-RegressionSolution_O\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution()</span></a>.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"RegressionSol-getLatestVersion__mlsol-getLatestVersion-example\">The following example shows how to get the latest version of</span> a solution\n and return its training status.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "solution_complete",\n "percentComplete": "100",\n "hasJobEnded": "true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-getName\" id=\"RegressionSol-getName\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-getName\">RegressionSolution - getName()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the name of the object to use for interaction\n with the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-getName__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getName__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getName__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getName__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getName__table_pps_43z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getName__table_pps_43z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getName__table_pps_43z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-getName__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getName__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getName__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getName__table_qps_43z_llb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getName__table_qps_43z_llb__entry__2\">Name of the solution object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to\n update</span>\n <span class=\"keyword apiname\">RegressionSolution</span>\n <span class=\"ph\">dataset information and print the name\n of the object.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Update solution\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'encodedQuery' : 'activeANYTHING'\n});\n\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('regression'));\n\nvar myRegression = new sn_ml.RegressionSolution({\n 'label': "my regression solution",\n 'dataset' : myIncidentData,\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\n 'predictedFieldName': 'category'\n});\n\n// update solution\nsn_ml.RegressionSolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', myRegression);\n\n// print solution name\ngs.print('Solution Name: '+myRegression.getName());</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Solution Name: ml_x_snc_global_global_my_solution_definition_4</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-getProperties\" id=\"RegressionSol-getProperties\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-getProperties\">RegressionSolution - getProperties()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets solution object\n properties</span>.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-getProperties__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getProperties__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getProperties__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getProperties__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_pps_43z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_pps_43z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_pps_43z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-getProperties__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\">Contents of the Dataset and <a class=\"xref\" href=\"#RegressionSol-RegressionSolution_O\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution()</span></a> object details in the\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\" class=\"xref\" title=\"Enables storing and retrieving solutions.\"><span class=\"keyword apiname\">RegressionSolutionStore</span></a>.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "datasetProperties": {Object},\n "domainName": "String",\n "encoder": {Object},\n "inputFieldNames": [Array],\n "label": "String",\n "name": "String",\n "predictedFieldName": "String",\n "predictedInterval": [Array],\n "processingLanguage": "String",\n "scope": "String",\n "stopwords": [Array],\n "trainingFrequency": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><p class=\"p\">Lists the properties of the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html#DDef-DatasetDefinition_O\" class=\"xref\" title=\"Creates an instance of the DatasetDefinition class, enabling you to define a dataset by table name, fields, and query.\"><span class=\"keyword apiname\">DatasetDefinition()</span></a> object associated with the\n solution.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "encodedQuery": "String",\n "fieldDetails": [Array],\n "fieldNames": [Array],\n "tableName": "String"\n}</code></pre>\n <p class=\"p\">Data type: Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.tableName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Name of the table for the dataset. For\n example, <code class=\"ph codeph\">"tableName" : "Incident"</code>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">List of field names from the specified table\n as strings. For example, <code class=\"ph codeph\">"fieldNames" : ["short_description",\n "priority"]</code>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">List of JavaScript objects that specify field\n properties.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "name": "String",\n "type": "String"\n }\n]</code></pre>\n <p class=\"p\">Data\n type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Name of the field defining the type of\n information to restrict this dataset to.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Machine-learning field type.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Encoded query string in standard Glide format.\n See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\" class=\"xref\">Encoded query\n strings</a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Domain name associated with this dataset. See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.encoder</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Encoder object assigned to this\n solution.</span> See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\" class=\"xref\" title=\"Creates an encoder.\">Encoder - Encoder(Object config)</a>.<p class=\"p\">Data type:\n Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.inputFieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">List of input field names as strings. The\n model uses these fields used to make\n predictions.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Identifies the prediction\n task.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "label": "my first prediction"\n}</code></pre>\n <p class=\"p\">Data\n type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">System-assigned name.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.predictedFieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Identifies a field to be trained for\n predictability.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.predictedInterval</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\">Range of values specifying the prediction\n confidence level.<p class=\"p\">Data type: Array</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.processingLanguage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Processing language in two-letter ISO 639-1 language code format.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.scope</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\">Object scope. Currently the only valid value is\n <code class=\"ph codeph\">global</code>.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.stopwords</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Optional. Preset\n list of strings that the system automatically generates based on the\n <span class=\"keyword parmname\">language</span> property setting. For details, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create a custom stopwords\n list</a>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.trainingFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">The frequency to retrain the model.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"RegressionSol-getProperties__ul_pmw_523_plb\">\n <li class=\"li\">every_30_days</li>\n <li class=\"li\">every_60_days</li>\n <li class=\"li\">every_90_days</li>\n <li class=\"li\">every_120_days</li>\n <li class=\"li\">every_180_days</li>\n <li class=\"li\">run_once</li>\n </ul>Default: run_once</div>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"RegressionSol-getProperties__mlsol-getProps-example-other1\">The\n following example gets properties of</span> a solution object <span class=\"ph\" id=\"RegressionSol-getProperties__mlsol-getProps-example-other2\">in the store.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression_solution');\n\ngs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));</code></pre>\n <div class=\"p\">Output:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">*** Script: {\n "datasetProperties": {\n "tableName": "cloudinfratext",\n "fieldNames": [\n "short_description",\n "sourcedc",\n "targetdc",\n "dbsize",\n "duration"\n ]\n },\n "domainName": "global",\n "encoderProperties": {\n "datasetsProperties": [],\n "name": "wc_regression"\n },\n "inputFieldNames": [\n "short_description",\n "sourcedc",\n "targetdc",\n "dbsize"\n ],\n "label": "Regression Test for DB Restore",\n "name": "ml_x_snc_global_global_regression",\n "predictedFieldName": "duration",\n "processingLanguage": "en",\n "scope": "global",\n "stopwords": [\n "Default English Stopwords"\n ],\n "trainingFrequency": "every_30_days"\n}</code></pre></div>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-getVersion_S\" id=\"RegressionSol-getVersion_S\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-getVersion_S\">RegressionSolution - getVersion(String version)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets a solution <span class=\"ph\">by provided version number.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-getVersion_S__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__1\">version</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__3\"><span class=\"ph\" id=\"RegressionSol-getVersion_S__mlsol-gerversion-returns-other\">Existing version number of</span> a solution.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-getVersion_S__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 15. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__2\">Specified version of the <a class=\"xref\" href=\"#RegressionSol-RegressionSolution_O\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution()</span></a> object on which you can call\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" class=\"xref\" title=\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolutionVersion</span></a> API methods.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"RegressionSol-getVersion_S__mlsol-gerversion-example-other\">The following example shows how to get the training status of</span> a solution\n by version number.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "solution_complete",\n "percentComplete": "100",\n "hasJobEnded": "true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-setActiveVersion_S\" id=\"RegressionSol-setActiveVersion_S\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-setActiveVersion_S\">RegressionSolution - setActiveVersion(String version)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Activates a specified version of a\n solution in the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-setActiveVersion_S__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 16. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__1\">version</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__3\">Name of the <a class=\"xref\" href=\"#RegressionSol-RegressionSolution_O\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution()</span></a> object version to activate.<p class=\"p\">Activating this version deactivates any other version.</p></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-setActiveVersion_S__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 17. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"RegressionSol-setActiveVersion_S__mlsol-setActive-example1\">The\n following example shows how to activate</span> a solution <span class=\"ph\" id=\"RegressionSol-setActiveVersion_S__mlsol-setActive-example2\">version in the store.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">sn_ml.RegressionSolution.setActiveVersion("ml_incident_categorization");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionSol-submitTrainingJob\" id=\"RegressionSol-submitTrainingJob\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionSol-submitTrainingJob\">RegressionSolution - submitTrainingJob()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Submits a training job.</span></p>\n <section class=\"section\">\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> Before running this method, you must first add a solution to the store using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html#RegressionStore-add_O\" class=\"xref\" title=\"Adds a new solution object to the store and returns a unique name.\"><span class=\"keyword apiname\">RegressionSolutionStore - add()</span></a> method.</div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionSol-submitTrainingJob__table_xmd_33z_llb\"><caption><span class=\"table--title-label\">Table 18. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionSol-submitTrainingJob__table_ymd_33z_llb\"><caption><span class=\"table--title-label\">Table 19. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" class=\"xref\" title=\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolutionVersion</span></a>\n <span class=\"ph\">object corresponding to the</span>\n <a class=\"xref\" href=\"#RegressionSol-RegressionSolution_O\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution</span></a>\n <span class=\"ph\">being trained.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"RegressionSol-submitTrainingJob__mlsol-submit-example-nonSol1\">The\n following example shows how to create a dataset, apply it to</span> a solution,\n add the solution <span class=\"ph\" id=\"RegressionSol-submitTrainingJob__mlsol-submit-example-nonSol2\">to a store, and submit the\n training job.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// Create a solution \nvar mySolution = new sn_ml.RegressionSolution({\n\n 'label': "my solution definition",\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);\n\n// Train the solution - this is a long running job \nvar myRegressionVersion = mySolution.submitTrainingJob();</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RegressionSolution - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206675\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206675\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"RegressionSolutionAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\",\n \"page_key\": 41206675,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 15021,\n \"img_count\": 0,\n \"read_time\": 6,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 1513\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RegressionSolution - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_RegressionSolutionAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_RegressionSolutionAPI\\\" id=\\\"RegressionSolutionAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_RegressionSolutionAPI\\\">RegressionSolution<span class=\\\"ph\\\"> - Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RegressionSolution</span> API is a scriptable object used in <span class=\\\"ph\\\">Predictive Intelligence</span> stores.</p>\\n <p class=\\\"p\\\">This <span class=\\\"ph\\\"> API requires the <span class=\\\"ph\\\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\\n within the <code class=\\\"ph codeph\\\">sn_ml</code> namespace.</span></p>\\n <div class=\\\"p\\\">The solution setup-to-training flow is as follows:<ol class=\\\"ol\\\" id=\\\"RegressionSolutionAPI__ol_mmm_n1c_dmb\\\">\\n <li class=\\\"li\\\">Create a dataset using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" class=\\\"xref\\\" title=\\\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\\\"><span class=\\\"keyword apiname\\\">DatasetDefinition</span></a> API.</li>\\n <li class=\\\"li\\\">Optional. Build an encoder using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" class=\\\"xref\\\" title=\\\"Scriptable object used in Predictive Intelligence stores. This object converts input data into vectors of numbers, based on encoder-specific goals and configurations. Encoders can be used independently to run encodings, or can be configured as part of solutions to encode text columns.\\\"><span class=\\\"keyword apiname\\\">Encoder</span></a> API.</li>\\n <li class=\\\"li\\\">Use the <a class=\\\"xref\\\" href=\\\"#RegressionSol-RegressionSolution_O\\\" title=\\\"Creates a regression solution.\\\">constructor</a> to create a regression solution object.</li>\\n <li class=\\\"li\\\">Add the solution object to the regression solution store using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html#RegressionStore-add_O\\\" class=\\\"xref\\\" title=\\\"Adds a new solution object to the store and returns a unique name.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionStore - add()</span></a> method.</li>\\n <li class=\\\"li\\\">Train the solution using the <a class=\\\"xref\\\" href=\\\"#RegressionSol-submitTrainingJob\\\" title=\\\"Submits a training job.\\\"><span class=\\\"keyword apiname\\\">submitTrainingJob()</span></a> method. This creates a version of the\\n object that you can manage using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span></a> API.</li>\\n <li class=\\\"li\\\">Get predictions using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html#RegressionVersion-predict_O_O\\\" class=\\\"xref\\\" title=\\\"Gets the input data for a prediction.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionVersion – predict()</span></a> method.</li>\\n </ol>\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This API runs <span class=\\\"ph\\\" id=\\\"RegressionSolutionAPI__ml-api-access-comp\\\">with full\\n privileges. To restrict user access, include an access control mechanism in the\\n script.</span></div></div>\\n <p class=\\\"p\\\">For usage guidelines, refer to <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=using-ml-apis&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Using ML APIs</a>.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_RegressionSol-RegressionSolution_O\\\" id=\\\"RegressionSol-RegressionSolution_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-RegressionSolution_O\\\">RegressionSolution - RegressionSolution(Object config)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Creates a regression solution.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:33.33333333333333%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:50%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">JavaScript object containing configuration\\n properties of the </span>solution.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "algorithmConfig": {Object},\\n "dataset": {Object},\\n "domainName": "String",\\n "encoder": {Object},\\n "inputFieldNames": [Array],\\n "label": "String",\\n "minRowCount": "String",\\n "predictedFieldName": "String",\\n "predictedInterval": [Array],\\n "processingLanguage": "String",\\n "stopwords": [Array],\\n "trainingFrequency": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.dataset</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" class=\\\"xref\\\" title=\\\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\\\"><span class=\\\"keyword apiname\\\">DatasetDefinition</span></a> name.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. <span class=\\\"ph\\\" id=\\\"RegressionSol-RegressionSolution_O__solution-obj-domainN-desc\\\">Domain name associated with this dataset. See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</span>\\n <p class=\\\"p\\\" id=\\\"RegressionSol-RegressionSolution_O__solution-obj-domainN-default\\\">Default: Current domain, for example, <code class=\\\"ph codeph\\\">"global"</code>.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.encoder</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. <span class=\\\"ph\\\">Trained encoder object to\\n assign to this solution.</span> See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\\\" class=\\\"xref\\\" title=\\\"Creates an encoder.\\\">Encoder - Encoder(Object config)</a>.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.inputFieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">List of input field names as strings. The\\n model uses these fields used to make\\n predictions.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">Identifies the prediction\\n task.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.minRowCount</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. Minimum number of records required in\\n the dataset for training.<p class=\\\"p\\\">Default: 10000</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.predictedFieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\">Mandatory unless setting <span class=\\\"keyword parmname\\\">predictedInterval</span>. <span class=\\\"ph\\\">Identifies a field to be trained for\\n predictability.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.predictedInterval</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\">Mandatory unless setting <span class=\\\"keyword parmname\\\">predictedFieldName</span>. Sets a range\\n of fields to train your solution for confidence. Supports providing\\n 2\\n non-numeric date fields. For example, <code class=\\\"ph codeph\\\">'predictedInterval':\\n ['sys_updated_on', 'sys_created_on']</code>.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.processingLanguage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. <span class=\\\"ph\\\" id=\\\"RegressionSol-RegressionSolution_O__solution-obj-lang-desc\\\">Processing language in two-letter ISO 639-1 language code format.</span>\\n <p class=\\\"p\\\">Default:\\n "en"</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.stopwords</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"RegressionSol-RegressionSolution_O__solution-obj-stop-desc\\\">Optional. Preset\\n list of strings that the system automatically generates based on the\\n <span class=\\\"keyword parmname\\\">language</span> property setting. For details, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create a custom stopwords\\n list</a>.</span>\\n <p class=\\\"p\\\">Default: English Stopwords</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__1\\\">config.trainingFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-RegressionSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">The frequency to retrain the model.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"RegressionSol-RegressionSolution_O__ul_pmw_523_plb\\\">\\n <li class=\\\"li\\\">every_30_days</li>\\n <li class=\\\"li\\\">every_60_days</li>\\n <li class=\\\"li\\\">every_90_days</li>\\n <li class=\\\"li\\\">every_120_days</li>\\n <li class=\\\"li\\\">every_180_days</li>\\n <li class=\\\"li\\\">run_once</li>\\n </ul>Default: run_once</div></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to create an object\\n and add it to the</span> RegressionSolution store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var myNewData = new sn_ml.DatasetDefinition(\\n { \\n 'tableName' : 'incident', \\n 'fieldNames' : ['category', 'short_description', 'priority'],\\n 'fieldDetails' : [\\n {\\n 'name' : 'category',\\n 'type' : 'nominal'\\n },\\n {\\n 'name' : 'short_description',\\n 'type' : 'text'\\n }], \\n 'encodedQuery' : 'activeANYTHING'\\n });\\n\\nvar mySimSolution = new sn_ml.SimilaritySolution({\\n 'label': "my solution definition",\\n 'dataset' : myNewData,\\n 'predictedFieldName' : 'category',\\n 'inputFieldNames': ['short_description']\\n});\\n\\nvar mySimilarityName = sn_ml.SimilaritySolutionStore.add(mySimSolution);</code></pre>\\n </div>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to create an object to train using the\\n <span class=\\\"keyword parmname\\\">predictedInterval</span> property.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var myIncidentData = new sn_ml.DatasetDefinition({\\n'tableName' : 'incident',\\n'fieldNames' : ['short_description', 'sys_updated_on','sys_created_on'],\\n'encodedQuery' : 'activeANYTHING'\\n});\\n \\nvar mySolution = new sn_ml.RegressionSolution({\\n'label': 'reg assinGroup',\\n'dataset' : myIncidentData,\\n'predictedInterval': ['sys_updated_on', 'sys_created_on'],\\n'inputFieldNames': ['short_description']\\n});\\n \\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution)</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-cancelTrainingJob\\\" id=\\\"RegressionSol-cancelTrainingJob\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-cancelTrainingJob\\\">RegressionSolution - cancelTrainingJob()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Cancels a job for</span> a solution object <span class=\\\"ph\\\">that has been submitted for training.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to cancel an existing\\n training job.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression');\\n\\nmySolution.cancelTrainingJob();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-getActiveVersion\\\" id=\\\"RegressionSol-getActiveVersion\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-getActiveVersion\\\">RegressionSolution - getActiveVersion()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the active</span>\\n <span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span> object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-getActiveVersion__table_tvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getActiveVersion__table_tvl_m3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-getActiveVersion__table_uvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getActiveVersion__table_uvl_m3z_llb__entry__2\\\">Active <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span></a> object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to get an\\n active</span>\\n <span class=\\\"keyword apiname\\\">RegressionSolution</span>\\n <span class=\\\"ph\\\">version from the store and return its\\n training status.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "solution_complete",\\n "percentComplete": "100",\\n "hasJobEnded": "true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-getAllVersions\\\" id=\\\"RegressionSol-getAllVersions\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-getAllVersions\\\">RegressionSolution - getAllVersions()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets all versions of</span> a <span class=\\\"keyword apiname\\\">RegressionSolution</span> object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-getAllVersions__table_tvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getAllVersions__table_tvl_m3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-getAllVersions__table_uvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getAllVersions__table_uvl_m3z_llb__entry__2\\\"><span class=\\\"ph\\\">Existing versions of a solution object.\\n See also</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span></a> API.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get all <span class=\\\"keyword apiname\\\">RegressionSolution</span>\\n version objects and call the <span class=\\\"keyword apiname\\\">getVersionNumber()</span> and\\n <span class=\\\"keyword apiname\\\">getStatus()</span> solution version methods on them.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\\n\\nvar mlSolutionVersions = mlSolution.getAllVersions();\\n\\nfor (i = 0; i < mlSolutionVersions.length; i++) {\\ngs.print("Version " + mlSolutionVersions[i].getVersionNumber() + " Status: " + mlSolutionVersions[i].getStatus() +"\\\\n");\\n};</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Version 3 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\\n\\nVersion 2 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\\n\\nVersion 1 Status: {"state":"solution_cancelled","percentComplete":"0","hasJobEnded":"true"}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-getLatestVersion\\\" id=\\\"RegressionSol-getLatestVersion\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-getLatestVersion\\\">RegressionSolution - getLatestVersion()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the latest version of</span> a solution.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-getLatestVersion__table_tvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getLatestVersion__table_tvl_m3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-getLatestVersion__table_uvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getLatestVersion__table_uvl_m3z_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span></a>\\n <span class=\\\"ph\\\"> object corresponding to the latest\\n version of</span> a <a class=\\\"xref\\\" href=\\\"#RegressionSol-RegressionSolution_O\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution()</span></a>.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"RegressionSol-getLatestVersion__mlsol-getLatestVersion-example\\\">The following example shows how to get the latest version of</span> a solution\\n and return its training status.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "solution_complete",\\n "percentComplete": "100",\\n "hasJobEnded": "true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-getName\\\" id=\\\"RegressionSol-getName\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-getName\\\">RegressionSolution - getName()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the name of the object to use for interaction\\n with the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-getName__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getName__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getName__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getName__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getName__table_pps_43z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getName__table_pps_43z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getName__table_pps_43z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-getName__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getName__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getName__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getName__table_qps_43z_llb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getName__table_qps_43z_llb__entry__2\\\">Name of the solution object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to\\n update</span>\\n <span class=\\\"keyword apiname\\\">RegressionSolution</span>\\n <span class=\\\"ph\\\">dataset information and print the name\\n of the object.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Update solution\\nvar myIncidentData = new sn_ml.DatasetDefinition({\\n 'tableName' : 'incident',\\n 'fieldNames' : ['category', 'short_description', 'priority'],\\n 'encodedQuery' : 'activeANYTHING'\\n});\\n\\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('regression'));\\n\\nvar myRegression = new sn_ml.RegressionSolution({\\n 'label': "my regression solution",\\n 'dataset' : myIncidentData,\\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\\n 'predictedFieldName': 'category'\\n});\\n\\n// update solution\\nsn_ml.RegressionSolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', myRegression);\\n\\n// print solution name\\ngs.print('Solution Name: '+myRegression.getName());</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Solution Name: ml_x_snc_global_global_my_solution_definition_4</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-getProperties\\\" id=\\\"RegressionSol-getProperties\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-getProperties\\\">RegressionSolution - getProperties()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets solution object\\n properties</span>.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-getProperties__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getProperties__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getProperties__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getProperties__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_pps_43z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_pps_43z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_pps_43z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-getProperties__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\">Contents of the Dataset and <a class=\\\"xref\\\" href=\\\"#RegressionSol-RegressionSolution_O\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution()</span></a> object details in the\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\" class=\\\"xref\\\" title=\\\"Enables storing and retrieving solutions.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionStore</span></a>.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "datasetProperties": {Object},\\n "domainName": "String",\\n "encoder": {Object},\\n "inputFieldNames": [Array],\\n "label": "String",\\n "name": "String",\\n "predictedFieldName": "String",\\n "predictedInterval": [Array],\\n "processingLanguage": "String",\\n "scope": "String",\\n "stopwords": [Array],\\n "trainingFrequency": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><p class=\\\"p\\\">Lists the properties of the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html#DDef-DatasetDefinition_O\\\" class=\\\"xref\\\" title=\\\"Creates an instance of the DatasetDefinition class, enabling you to define a dataset by table name, fields, and query.\\\"><span class=\\\"keyword apiname\\\">DatasetDefinition()</span></a> object associated with the\\n solution.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "encodedQuery": "String",\\n "fieldDetails": [Array],\\n "fieldNames": [Array],\\n "tableName": "String"\\n}</code></pre>\\n <p class=\\\"p\\\">Data type: Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Name of the table for the dataset. For\\n example, <code class=\\\"ph codeph\\\">"tableName" : "Incident"</code>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">List of field names from the specified table\\n as strings. For example, <code class=\\\"ph codeph\\\">"fieldNames" : ["short_description",\\n "priority"]</code>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">List of JavaScript objects that specify field\\n properties.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "name": "String",\\n "type": "String"\\n }\\n]</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Name of the field defining the type of\\n information to restrict this dataset to.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Machine-learning field type.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Encoded query string in standard Glide format.\\n See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\\\" class=\\\"xref\\\">Encoded query\\n strings</a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Domain name associated with this dataset. See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.encoder</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Encoder object assigned to this\\n solution.</span> See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\\\" class=\\\"xref\\\" title=\\\"Creates an encoder.\\\">Encoder - Encoder(Object config)</a>.<p class=\\\"p\\\">Data type:\\n Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.inputFieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">List of input field names as strings. The\\n model uses these fields used to make\\n predictions.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Identifies the prediction\\n task.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "label": "my first prediction"\\n}</code></pre>\\n <p class=\\\"p\\\">Data\\n type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">System-assigned name.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.predictedFieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Identifies a field to be trained for\\n predictability.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.predictedInterval</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\">Range of values specifying the prediction\\n confidence level.<p class=\\\"p\\\">Data type: Array</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.processingLanguage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Processing language in two-letter ISO 639-1 language code format.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.scope</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\">Object scope. Currently the only valid value is\\n <code class=\\\"ph codeph\\\">global</code>.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.stopwords</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Optional. Preset\\n list of strings that the system automatically generates based on the\\n <span class=\\\"keyword parmname\\\">language</span> property setting. For details, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create a custom stopwords\\n list</a>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.trainingFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">The frequency to retrain the model.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"RegressionSol-getProperties__ul_pmw_523_plb\\\">\\n <li class=\\\"li\\\">every_30_days</li>\\n <li class=\\\"li\\\">every_60_days</li>\\n <li class=\\\"li\\\">every_90_days</li>\\n <li class=\\\"li\\\">every_120_days</li>\\n <li class=\\\"li\\\">every_180_days</li>\\n <li class=\\\"li\\\">run_once</li>\\n </ul>Default: run_once</div>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"RegressionSol-getProperties__mlsol-getProps-example-other1\\\">The\\n following example gets properties of</span> a solution object <span class=\\\"ph\\\" id=\\\"RegressionSol-getProperties__mlsol-getProps-example-other2\\\">in the store.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression_solution');\\n\\ngs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));</code></pre>\\n <div class=\\\"p\\\">Output:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">*** Script: {\\n "datasetProperties": {\\n "tableName": "cloudinfratext",\\n "fieldNames": [\\n "short_description",\\n "sourcedc",\\n "targetdc",\\n "dbsize",\\n "duration"\\n ]\\n },\\n "domainName": "global",\\n "encoderProperties": {\\n "datasetsProperties": [],\\n "name": "wc_regression"\\n },\\n "inputFieldNames": [\\n "short_description",\\n "sourcedc",\\n "targetdc",\\n "dbsize"\\n ],\\n "label": "Regression Test for DB Restore",\\n "name": "ml_x_snc_global_global_regression",\\n "predictedFieldName": "duration",\\n "processingLanguage": "en",\\n "scope": "global",\\n "stopwords": [\\n "Default English Stopwords"\\n ],\\n "trainingFrequency": "every_30_days"\\n}</code></pre></div>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-getVersion_S\\\" id=\\\"RegressionSol-getVersion_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-getVersion_S\\\">RegressionSolution - getVersion(String version)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets a solution <span class=\\\"ph\\\">by provided version number.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-getVersion_S__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__1\\\">version</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getVersion_S__table_pps_43z_llb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"RegressionSol-getVersion_S__mlsol-gerversion-returns-other\\\">Existing version number of</span> a solution.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-getVersion_S__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-getVersion_S__table_qps_43z_llb__entry__2\\\">Specified version of the <a class=\\\"xref\\\" href=\\\"#RegressionSol-RegressionSolution_O\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution()</span></a> object on which you can call\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span></a> API methods.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"RegressionSol-getVersion_S__mlsol-gerversion-example-other\\\">The following example shows how to get the training status of</span> a solution\\n by version number.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "solution_complete",\\n "percentComplete": "100",\\n "hasJobEnded": "true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-setActiveVersion_S\\\" id=\\\"RegressionSol-setActiveVersion_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-setActiveVersion_S\\\">RegressionSolution - setActiveVersion(String version)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Activates a specified version of a\\n solution in the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-setActiveVersion_S__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__1\\\">version</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-setActiveVersion_S__table_pps_43z_llb__entry__3\\\">Name of the <a class=\\\"xref\\\" href=\\\"#RegressionSol-RegressionSolution_O\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution()</span></a> object version to activate.<p class=\\\"p\\\">Activating this version deactivates any other version.</p></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-setActiveVersion_S__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-setActiveVersion_S__table_qps_43z_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"RegressionSol-setActiveVersion_S__mlsol-setActive-example1\\\">The\\n following example shows how to activate</span> a solution <span class=\\\"ph\\\" id=\\\"RegressionSol-setActiveVersion_S__mlsol-setActive-example2\\\">version in the store.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">sn_ml.RegressionSolution.setActiveVersion("ml_incident_categorization");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionSol-submitTrainingJob\\\" id=\\\"RegressionSol-submitTrainingJob\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionSol-submitTrainingJob\\\">RegressionSolution - submitTrainingJob()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Submits a training job.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Before running this method, you must first add a solution to the store using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html#RegressionStore-add_O\\\" class=\\\"xref\\\" title=\\\"Adds a new solution object to the store and returns a unique name.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionStore - add()</span></a> method.</div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionSol-submitTrainingJob__table_xmd_33z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-submitTrainingJob__table_xmd_33z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionSol-submitTrainingJob__table_ymd_33z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 19. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionSol-submitTrainingJob__table_ymd_33z_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span></a>\\n <span class=\\\"ph\\\">object corresponding to the</span>\\n <a class=\\\"xref\\\" href=\\\"#RegressionSol-RegressionSolution_O\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution</span></a>\\n <span class=\\\"ph\\\">being trained.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"RegressionSol-submitTrainingJob__mlsol-submit-example-nonSol1\\\">The\\n following example shows how to create a dataset, apply it to</span> a solution,\\n add the solution <span class=\\\"ph\\\" id=\\\"RegressionSol-submitTrainingJob__mlsol-submit-example-nonSol2\\\">to a store, and submit the\\n training job.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Create a dataset \\nvar myData = new sn_ml.DatasetDefinition({\\n\\n 'tableName' : 'incident',\\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\\n 'encodedQuery' : 'activeANYTHING'\\n\\n});\\n\\n// Create a solution \\nvar mySolution = new sn_ml.RegressionSolution({\\n\\n 'label': "my solution definition",\\n 'dataset' : myData,\\n 'predictedFieldName' : 'assignment_group',\\n 'inputFieldNames':['short_description']\\n\\n});\\n\\n// Add the solution to the store to later be able to retrieve it.\\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);\\n\\n// Train the solution - this is a long running job \\nvar myRegressionVersion = mySolution.submitTrainingJob();</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RegressionSolution - Global\n\nThe RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThe solution setup-to-training flow is as follows:\n\n1. Create a dataset using the DatasetDefinition API.\n2. Optional. Build an encoder using the Encoder API.\n3. Use the constructor to create a regression solution object.\n4. Add the solution object to the regression solution store using the RegressionSolutionStore - add() method.\n5. Train the solution using the submitTrainingJob() method. This creates a version of the\n object that you can manage using the RegressionSolutionVersion API.\n6. Get predictions using the RegressionSolutionVersion – predict() method.\n\nNote: This API runs with full\nprivileges. To restrict user access, include an access control mechanism in the\nscript.\n\nFor usage guidelines, refer to Using ML APIs.\n\n## RegressionSolution - RegressionSolution(Object config)\n\nCreates a regression solution.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| config | Object | JavaScript object containing configuration properties of the solution. ```None { \"algorithmConfig\": {Object}, \"dataset\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"inputFieldNames\": [Array], \"label\": \"String\", \"minRowCount\": \"String\", \"predictedFieldName\": \"String\", \"predictedInterval\": [Array], \"processingLanguage\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\" } ``` |\n| config.dataset | Object | DatasetDefinition name. |\n| config.domainName | String | Optional. Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Default: Current domain, for example, `\"global\"`. |\n| config.encoder | Object | Optional. Trained encoder object to assign to this solution. See Encoder - Encoder(Object config). |\n| config.inputFieldNames | Array | List of input field names as strings. The model uses these fields used to make predictions. |\n| config.label | String | Identifies the prediction task. |\n| config.minRowCount | String | Optional. Minimum number of records required in the dataset for training. Default: 10000 |\n| config.predictedFieldName | String | Mandatory unless setting predictedInterval. Identifies a field to be trained for predictability. |\n| config.predictedInterval | Array | Mandatory unless setting predictedFieldName. Sets a range of fields to train your solution for confidence. Supports providing 2 non-numeric date fields. For example, `'predictedInterval': ['sys_updated_on', 'sys_created_on']`. |\n| config.processingLanguage | String | Optional. Processing language in two-letter ISO 639-1 language code format. Default: \"en\" |\n| config.stopwords | Array | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Default: English Stopwords |\n| config.trainingFrequency | String | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once |\n\n### Example\n\nThe following example shows how to create an object\nand add it to the RegressionSolution store.\n\n```None\nvar myNewData = new sn_ml.DatasetDefinition(\n { \n 'tableName' : 'incident', \n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'fieldDetails' : [\n {\n 'name' : 'category',\n 'type' : 'nominal'\n },\n {\n 'name' : 'short_description',\n 'type' : 'text'\n }], \n 'encodedQuery' : 'activeANYTHING'\n });\n\nvar mySimSolution = new sn_ml.SimilaritySolution({\n 'label': \"my solution definition\",\n 'dataset' : myNewData,\n 'predictedFieldName' : 'category',\n 'inputFieldNames': ['short_description']\n});\n\nvar mySimilarityName = sn_ml.SimilaritySolutionStore.add(mySimSolution);\n```\n\n### Example\n\nThe following example shows how to create an object to train using the\npredictedInterval property.\n\n```None\nvar myIncidentData = new sn_ml.DatasetDefinition({\n'tableName' : 'incident',\n'fieldNames' : ['short_description', 'sys_updated_on','sys_created_on'],\n'encodedQuery' : 'activeANYTHING'\n});\n \nvar mySolution = new sn_ml.RegressionSolution({\n'label': 'reg assinGroup',\n'dataset' : myIncidentData,\n'predictedInterval': ['sys_updated_on', 'sys_created_on'],\n'inputFieldNames': ['short_description']\n});\n \nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution)\n```\n\n## RegressionSolution - cancelTrainingJob()\n\nCancels a job for a solution object that has been submitted for training.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to cancel an existing\ntraining job.\n\n```None\nvar mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression');\n\nmySolution.cancelTrainingJob();\n```\n\n## RegressionSolution - getActiveVersion()\n\nGets the active\nRegressionSolutionVersion object.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| Object | Active RegressionSolutionVersion object. |\n\n### Example\n\nThe following example shows how to get an\nactive\nRegressionSolution\nversion from the store and return its\ntraining status.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## RegressionSolution - getAllVersions()\n\nGets all versions of a RegressionSolution object.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| Array | Existing versions of a solution object. See also RegressionSolutionVersion API. |\n\n### Example\n\nThe following example shows how to get all RegressionSolution\nversion objects and call the getVersionNumber() and\ngetStatus() solution version methods on them.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\nvar mlSolutionVersions = mlSolution.getAllVersions();\n\nfor (i = 0; i < mlSolutionVersions.length; i++) {\ngs.print(\"Version \" + mlSolutionVersions[i].getVersionNumber() + \" Status: \" + mlSolutionVersions[i].getStatus() +\"\\n\");\n};\n```\n\nOutput:\n\n```None\nVersion 3 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 2 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 1 Status: {\"state\":\"solution_cancelled\",\"percentComplete\":\"0\",\"hasJobEnded\":\"true\"}\n```\n\n## RegressionSolution - getLatestVersion()\n\nGets the latest version of a solution.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| Object | RegressionSolutionVersion object corresponding to the latest version of a RegressionSolution(). |\n\n### Example\n\nThe following example shows how to get the latest version of a solution\nand return its training status.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## RegressionSolution - getName()\n\nGets the name of the object to use for interaction\nwith the store.\n\nTable 10. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 11. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the solution object. |\n\n### Example\n\nThe following example shows how to\nupdate\nRegressionSolution\ndataset information and print the name\nof the object.\n\n```None\n// Update solution\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'encodedQuery' : 'activeANYTHING'\n});\n\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('regression'));\n\nvar myRegression = new sn_ml.RegressionSolution({\n 'label': \"my regression solution\",\n 'dataset' : myIncidentData,\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\n 'predictedFieldName': 'category'\n});\n\n// update solution\nsn_ml.RegressionSolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', myRegression);\n\n// print solution name\ngs.print('Solution Name: '+myRegression.getName());\n```\n\nOutput:\n\n```None\nSolution Name: ml_x_snc_global_global_my_solution_definition_4\n```\n\n## RegressionSolution - getProperties()\n\nGets solution object\nproperties.\n\nTable 12. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 13. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and RegressionSolution() object details in the RegressionSolutionStore. ```None { \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"inputFieldNames\": [Array], \"label\": \"String\", \"name\": \"String\", \"predictedFieldName\": \"String\", \"predictedInterval\": [Array], \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\" } ``` |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoder | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.predictedInterval | Range of values specifying the prediction confidence level. Data type: Array |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n\n### Example\n\nThe\nfollowing example gets properties of a solution object in the store.\n\n```None\nvar mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression_solution');\n\ngs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));\n```\nOutput:\n```None\n*** Script: {\n \"datasetProperties\": {\n \"tableName\": \"cloudinfratext\",\n \"fieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\",\n \"duration\"\n ]\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [],\n \"name\": \"wc_regression\"\n },\n \"inputFieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\"\n ],\n \"label\": \"Regression Test for DB Restore\",\n \"name\": \"ml_x_snc_global_global_regression\",\n \"predictedFieldName\": \"duration\",\n \"processingLanguage\": \"en\",\n \"scope\": \"global\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"trainingFrequency\": \"every_30_days\"\n}\n```\n\n## RegressionSolution - getVersion(String version)\n\nGets a solution by provided version number.\n\nTable 14. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Existing version number of a solution. |\n\nTable 15. Returns\n| Type | Description |\n| --- | --- |\n| Object | Specified version of the RegressionSolution() object on which you can call RegressionSolutionVersion API methods. |\n\n### Example\n\nThe following example shows how to get the training status of a solution\nby version number.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## RegressionSolution - setActiveVersion(String version)\n\nActivates a specified version of a\nsolution in the store.\n\nTable 16. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Name of the RegressionSolution() object version to activate. Activating this version deactivates any other version. |\n\nTable 17. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe\nfollowing example shows how to activate a solution version in the store.\n\n```None\nsn_ml.RegressionSolution.setActiveVersion(\"ml_incident_categorization\");\n```\n\n## RegressionSolution - submitTrainingJob()\n\nSubmits a training job.\n\nNote: Before running this method, you must first add a solution to the store using the RegressionSolutionStore - add() method.\n\nTable 18. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 19. Returns\n| Type | Description |\n| --- | --- |\n| Object | RegressionSolutionVersion object corresponding to the RegressionSolution being trained. |\n\n### Example\n\nThe\nfollowing example shows how to create a dataset, apply it to a solution,\nadd the solution to a store, and submit the\ntraining job.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// Create a solution \nvar mySolution = new sn_ml.RegressionSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);\n\n// Train the solution - this is a long running job \nvar myRegressionVersion = mySolution.submitTrainingJob();\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RegressionSolution - Global\ndescription: The RegressionSolution API is a scriptable object used in Predictive\n Intelligence stores.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RegressionSolution - Global\n\nThe RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThe solution setup-to-training flow is as follows:\n\n1. Create a dataset using the DatasetDefinition API.\n2. Optional. Build an encoder using the Encoder API.\n3. Use the constructor to create a regression solution object.\n4. Add the solution object to the regression solution store using the RegressionSolutionStore - add() method.\n5. Train the solution using the submitTrainingJob() method. This creates a version of the\n object that you can manage using the RegressionSolutionVersion API.\n6. Get predictions using the RegressionSolutionVersion – predict() method.\n\nNote: This API runs with full\nprivileges. To restrict user access, include an access control mechanism in the\nscript.\n\nFor usage guidelines, refer to Using ML APIs.\n\n## RegressionSolution - RegressionSolution(Object config)\n\nCreates a regression solution.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| config | Object | JavaScript object containing configuration properties of the solution. ```None { \"algorithmConfig\": {Object}, \"dataset\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"inputFieldNames\": [Array], \"label\": \"String\", \"minRowCount\": \"String\", \"predictedFieldName\": \"String\", \"predictedInterval\": [Array], \"processingLanguage\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\" } ``` |\n| config.dataset | Object | DatasetDefinition name. |\n| config.domainName | String | Optional. Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Default: Current domain, for example, `\"global\"`. |\n| config.encoder | Object | Optional. Trained encoder object to assign to this solution. See Encoder - Encoder(Object config). |\n| config.inputFieldNames | Array | List of input field names as strings. The model uses these fields used to make predictions. |\n| config.label | String | Identifies the prediction task. |\n| config.minRowCount | String | Optional. Minimum number of records required in the dataset for training. Default: 10000 |\n| config.predictedFieldName | String | Mandatory unless setting predictedInterval. Identifies a field to be trained for predictability. |\n| config.predictedInterval | Array | Mandatory unless setting predictedFieldName. Sets a range of fields to train your solution for confidence. Supports providing 2 non-numeric date fields. For example, `'predictedInterval': ['sys_updated_on', 'sys_created_on']`. |\n| config.processingLanguage | String | Optional. Processing language in two-letter ISO 639-1 language code format. Default: \"en\" |\n| config.stopwords | Array | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Default: English Stopwords |\n| config.trainingFrequency | String | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once |\n\n### Example\n\nThe following example shows how to create an object\nand add it to the RegressionSolution store.\n\n```None\nvar myNewData = new sn_ml.DatasetDefinition(\n { \n 'tableName' : 'incident', \n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'fieldDetails' : [\n {\n 'name' : 'category',\n 'type' : 'nominal'\n },\n {\n 'name' : 'short_description',\n 'type' : 'text'\n }], \n 'encodedQuery' : 'activeANYTHING'\n });\n\nvar mySimSolution = new sn_ml.SimilaritySolution({\n 'label': \"my solution definition\",\n 'dataset' : myNewData,\n 'predictedFieldName' : 'category',\n 'inputFieldNames': ['short_description']\n});\n\nvar mySimilarityName = sn_ml.SimilaritySolutionStore.add(mySimSolution);\n```\n\n### Example\n\nThe following example shows how to create an object to train using the\npredictedInterval property.\n\n```None\nvar myIncidentData = new sn_ml.DatasetDefinition({\n'tableName' : 'incident',\n'fieldNames' : ['short_description', 'sys_updated_on','sys_created_on'],\n'encodedQuery' : 'activeANYTHING'\n});\n \nvar mySolution = new sn_ml.RegressionSolution({\n'label': 'reg assinGroup',\n'dataset' : myIncidentData,\n'predictedInterval': ['sys_updated_on', 'sys_created_on'],\n'inputFieldNames': ['short_description']\n});\n \nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution)\n```\n\n## RegressionSolution - cancelTrainingJob()\n\nCancels a job for a solution object that has been submitted for training.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to cancel an existing\ntraining job.\n\n```None\nvar mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression');\n\nmySolution.cancelTrainingJob();\n```\n\n## RegressionSolution - getActiveVersion()\n\nGets the active\nRegressionSolutionVersion object.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| Object | Active RegressionSolutionVersion object. |\n\n### Example\n\nThe following example shows how to get an\nactive\nRegressionSolution\nversion from the store and return its\ntraining status.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## RegressionSolution - getAllVersions()\n\nGets all versions of a RegressionSolution object.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| Array | Existing versions of a solution object. See also RegressionSolutionVersion API. |\n\n### Example\n\nThe following example shows how to get all RegressionSolution\nversion objects and call the getVersionNumber() and\ngetStatus() solution version methods on them.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\nvar mlSolutionVersions = mlSolution.getAllVersions();\n\nfor (i = 0; i < mlSolutionVersions.length; i++) {\ngs.print(\"Version \" + mlSolutionVersions[i].getVersionNumber() + \" Status: \" + mlSolutionVersions[i].getStatus() +\"\\n\");\n};\n```\n\nOutput:\n\n```None\nVersion 3 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 2 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 1 Status: {\"state\":\"solution_cancelled\",\"percentComplete\":\"0\",\"hasJobEnded\":\"true\"}\n```\n\n## RegressionSolution - getLatestVersion()\n\nGets the latest version of a solution.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| Object | RegressionSolutionVersion object corresponding to the latest version of a RegressionSolution(). |\n\n### Example\n\nThe following example shows how to get the latest version of a solution\nand return its training status.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## RegressionSolution - getName()\n\nGets the name of the object to use for interaction\nwith the store.\n\nTable 10. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 11. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the solution object. |\n\n### Example\n\nThe following example shows how to\nupdate\nRegressionSolution\ndataset information and print the name\nof the object.\n\n```None\n// Update solution\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'encodedQuery' : 'activeANYTHING'\n});\n\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('regression'));\n\nvar myRegression = new sn_ml.RegressionSolution({\n 'label': \"my regression solution\",\n 'dataset' : myIncidentData,\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\n 'predictedFieldName': 'category'\n});\n\n// update solution\nsn_ml.RegressionSolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', myRegression);\n\n// print solution name\ngs.print('Solution Name: '+myRegression.getName());\n```\n\nOutput:\n\n```None\nSolution Name: ml_x_snc_global_global_my_solution_definition_4\n```\n\n## RegressionSolution - getProperties()\n\nGets solution object\nproperties.\n\nTable 12. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 13. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and RegressionSolution() object details in the RegressionSolutionStore. ```None { \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"inputFieldNames\": [Array], \"label\": \"String\", \"name\": \"String\", \"predictedFieldName\": \"String\", \"predictedInterval\": [Array], \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\" } ``` |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoder | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.predictedInterval | Range of values specifying the prediction confidence level. Data type: Array |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n\n### Example\n\nThe\nfollowing example gets properties of a solution object in the store.\n\n```None\nvar mySolution = sn_ml.RegressionSolutionStore.get('ml_sn_global_global_regression_solution');\n\ngs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));\n```\nOutput:\n```None\n*** Script: {\n \"datasetProperties\": {\n \"tableName\": \"cloudinfratext\",\n \"fieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\",\n \"duration\"\n ]\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [],\n \"name\": \"wc_regression\"\n },\n \"inputFieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\"\n ],\n \"label\": \"Regression Test for DB Restore\",\n \"name\": \"ml_x_snc_global_global_regression\",\n \"predictedFieldName\": \"duration\",\n \"processingLanguage\": \"en\",\n \"scope\": \"global\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"trainingFrequency\": \"every_30_days\"\n}\n```\n\n## RegressionSolution - getVersion(String version)\n\nGets a solution by provided version number.\n\nTable 14. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Existing version number of a solution. |\n\nTable 15. Returns\n| Type | Description |\n| --- | --- |\n| Object | Specified version of the RegressionSolution() object on which you can call RegressionSolutionVersion API methods. |\n\n### Example\n\nThe following example shows how to get the training status of a solution\nby version number.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_x_snc_global_global_regression');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## RegressionSolution - setActiveVersion(String version)\n\nActivates a specified version of a\nsolution in the store.\n\nTable 16. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Name of the RegressionSolution() object version to activate. Activating this version deactivates any other version. |\n\nTable 17. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe\nfollowing example shows how to activate a solution version in the store.\n\n```None\nsn_ml.RegressionSolution.setActiveVersion(\"ml_incident_categorization\");\n```\n\n## RegressionSolution - submitTrainingJob()\n\nSubmits a training job.\n\nNote: Before running this method, you must first add a solution to the store using the RegressionSolutionStore - add() method.\n\nTable 18. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 19. Returns\n| Type | Description |\n| --- | --- |\n| Object | RegressionSolutionVersion object corresponding to the RegressionSolution being trained. |\n\n### Example\n\nThe\nfollowing example shows how to create a dataset, apply it to a solution,\nadd the solution to a store, and submit the\ntraining job.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// Create a solution \nvar mySolution = new sn_ml.RegressionSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);\n\n// Train the solution - this is a long running job \nvar myRegressionVersion = mySolution.submitTrainingJob();\n```\n"}}},{"rowIdx":1995,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RegressionSolutionStore - Global"},"description":{"kind":"string","value":"Enables storing and retrieving solutions."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_RegressionSolutionStoreAPI\"><article class=\"nested0\" aria-labelledby=\"title_RegressionSolutionStoreAPI\" id=\"RegressionSolutionStoreAPI\">\n <h1 class=\"title topictitle1\" id=\"title_RegressionSolutionStoreAPI\">RegressionSolutionStore <span class=\"ph\">- Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\"><span class=\"ph\">\n <span class=\"ph\" id=\"RegressionSolutionStoreAPI__mlstore-concept-sdesc-e\">Enables storing\n and retrieving</span> solutions.</span></p>\n <p class=\"p\">The <span class=\"keyword apiname\">RegressionSolutionStore</span>\n <span class=\"ph\"> API requires the <span class=\"ph\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\n within the <code class=\"ph codeph\">sn_ml</code> namespace.</span></p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionStore-add_O\" id=\"RegressionStore-add_O\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionStore-add_O\">RegressionSolutionStore - add(Object mlSolution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Adds a new solution <span class=\"ph\" id=\"RegressionStore-add_O__mlstore-add-sdesc-e\">object to the store and returns a unique name.</span>\n </span></p>\n <section class=\"section\">\n <div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> Label values do not need to be unique. For example, if you run this method\n with the same label 10 times, this method adds 10 different uniquely-named\n objects to the store.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionStore-add_O__table_vwy_1fr_llb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-add_O__table_vwy_1fr_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-add_O__table_vwy_1fr_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-add_O__table_vwy_1fr_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-add_O__table_vwy_1fr_llb__entry__1\">mlSolution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-add_O__table_vwy_1fr_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" class=\"xref\" title=\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\">RegressionSolution</a></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-add_O__table_vwy_1fr_llb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\" class=\"xref\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution()</span></a>\n <span class=\"ph\">object to add to the store.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionStore-add_O__table_wwy_1fr_llb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-add_O__table_wwy_1fr_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-add_O__table_wwy_1fr_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-add_O__table_wwy_1fr_llb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-add_O__table_wwy_1fr_llb__entry__2\">System-generated solution name.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example\n shows how to add</span> a solution <span class=\"ph\">to the\n store.</span> Use <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-submitTrainingJob\" class=\"xref\" title=\"Submits a training job.\"><span class=\"keyword apiname\">RegressionSolution - submitTrainingJob()</span></a> to train the\n Solution after adding it to the store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// Create an solution \nvar mySolution = new sn_ml.RegressionSolution({\n\n 'label': "my solution definition",\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionStore-deleteObject_S\" id=\"RegressionStore-deleteObject_S\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionStore-deleteObject_S\">RegressionSolutionStore - deleteObject(String name)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Removes a specified solution object from the\n store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionStore-deleteObject_S__table_rmj_lfr_llb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__3\">Name of the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\" class=\"xref\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution()</span></a>\n <span class=\"ph\">object to be deleted.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionStore-deleteObject_S__table_smj_lfr_llb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to delete a solution\n from the store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">sn_ml.RegressionSolutionStore.deleteObject("ml_sn_global_global_solution");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionStore-get_S\" id=\"RegressionStore-get_S\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionStore-get_S\">RegressionSolutionStore - get(String name)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets a solution object from the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionStore-get_S__table_zvw_v2r_llb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-get_S__table_zvw_v2r_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-get_S__table_zvw_v2r_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-get_S__table_zvw_v2r_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-get_S__table_zvw_v2r_llb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-get_S__table_zvw_v2r_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-get_S__table_zvw_v2r_llb__entry__3\">Name of a solution in the store.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionStore-get_S__table_aww_v2r_llb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-get_S__table_aww_v2r_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-get_S__table_aww_v2r_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-get_S__table_aww_v2r_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-get_S__table_aww_v2r_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" class=\"xref\" title=\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolution</span></a>\n <span class=\"ph\">object. Returns an error if the object does not\n exist.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to get a solution\n object from the store using the <span class=\"keyword apiname\">get()</span> method and view its\n training status using the</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getActiveVersion\" class=\"xref\" title=\"Gets the active RegressionSolutionVersion object.\">RegressionSolution - getActiveVersion()</a> and\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html#RegressionVersion-getStatus_B\" class=\"xref\" title=\"Gets training completion status.\">RegressionSolutionVersion - getStatus()</a> methods.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get status\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state":"solution_complete",\n "percentComplete":"100",\n "hasJobEnded":"true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionStore-getAllNames\" id=\"RegressionStore-getAllNames\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionStore-getAllNames\">RegressionSolutionStore - getAllNames(Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the names of all solution definition\n records in the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionStore-getAllNames__id_bfn_kwh_wnb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Options for restricting results within the specified\n properties.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "label": "String",\n "domainName": "String",\n "scope": "String"\n};</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Optional. Label of your solution object.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Optional. Name of the domain for your solution object. Refer to <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options.scope</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Optional. Name of an <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_ApplicationScope&version=vancouver&pubname=vancouver-application-development\" class=\"xref\">application scope</a> for\n your solution object.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionStore-getAllNames__table_aww_v2r_llb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__2\">List of strings representing solution object\n names in the store.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, the\n <span class=\"keyword apiname\">getAllNames()</span> method returns a list of all names in the\n store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">gs.print(JSON.stringify(JSON.parse(sn_ml.RegressionSolutionStore.getAllNames()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n "ml_x_snc_global_global_my_solution_definition_3",\n "ml_incident_assignment",\n "ml_x_snc_global_global_my_solution_definition",\n "ml_x_snc_global_global_my_solution_definition_2",\n "ml_sn_global_global_incident_service"\n]</code></pre>\n </div>\n <div class=\"example\" id=\"RegressionStore-getAllNames__example_jzt_l5h_wnb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, the\n <span class=\"keyword apiname\">getAllNames()</span> method returns only names associated with\n values set in the <span class=\"keyword parmname\">options</span> parameter.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var options = {\n 'label' : 'my solution definition',\n 'domainName' : 'global',\n 'scope' : 'global'\n};\nvar solNames = sn_ml.RegressionSolutionStore.getAllNames(options);\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n "ml_x_snc_global_global_my_solution_definition"\n]</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionStore-update_S_O\" id=\"RegressionStore-update_S_O\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionStore-update_S_O\">RegressionSolutionStore - update(String name, Object mlSolution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Replaces an existing object in the store with the\n object passed as a parameter. The object name provided must be empty or\n match.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionStore-update_S_O__table_v5p_wxr_llb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__3\">Name of the solution to update.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__1\">mlSolution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" class=\"xref\" title=\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">RegressionSolution</span></a></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\" class=\"xref\" title=\"Creates a regression solution.\"><span class=\"keyword apiname\">RegressionSolution()</span></a>\n <span class=\"ph\">object properties to update.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionStore-update_S_O__table_w5p_wxr_llb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to update a solution\n object in the store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var solutionUpdate = new sn_ml.RegressionSolution({\n 'label': 'my solution definition',\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames': ['short_description']\n});\n\nsn_ml.RegressionSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RegressionSolutionStore - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206679\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206679\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"RegressionSolutionStoreAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"Enables storing and retrieving solutions.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\",\n \"page_key\": 41206679,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 5033,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 534\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RegressionSolutionStore - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_RegressionSolutionStoreAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_RegressionSolutionStoreAPI\\\" id=\\\"RegressionSolutionStoreAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_RegressionSolutionStoreAPI\\\">RegressionSolutionStore <span class=\\\"ph\\\">- Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">\\n <span class=\\\"ph\\\" id=\\\"RegressionSolutionStoreAPI__mlstore-concept-sdesc-e\\\">Enables storing\\n and retrieving</span> solutions.</span></p>\\n <p class=\\\"p\\\">The <span class=\\\"keyword apiname\\\">RegressionSolutionStore</span>\\n <span class=\\\"ph\\\"> API requires the <span class=\\\"ph\\\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\\n within the <code class=\\\"ph codeph\\\">sn_ml</code> namespace.</span></p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionStore-add_O\\\" id=\\\"RegressionStore-add_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionStore-add_O\\\">RegressionSolutionStore - add(Object mlSolution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Adds a new solution <span class=\\\"ph\\\" id=\\\"RegressionStore-add_O__mlstore-add-sdesc-e\\\">object to the store and returns a unique name.</span>\\n </span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Label values do not need to be unique. For example, if you run this method\\n with the same label 10 times, this method adds 10 different uniquely-named\\n objects to the store.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionStore-add_O__table_vwy_1fr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-add_O__table_vwy_1fr_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-add_O__table_vwy_1fr_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-add_O__table_vwy_1fr_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-add_O__table_vwy_1fr_llb__entry__1\\\">mlSolution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-add_O__table_vwy_1fr_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\\\">RegressionSolution</a></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-add_O__table_vwy_1fr_llb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution()</span></a>\\n <span class=\\\"ph\\\">object to add to the store.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionStore-add_O__table_wwy_1fr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-add_O__table_wwy_1fr_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-add_O__table_wwy_1fr_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-add_O__table_wwy_1fr_llb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-add_O__table_wwy_1fr_llb__entry__2\\\">System-generated solution name.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example\\n shows how to add</span> a solution <span class=\\\"ph\\\">to the\\n store.</span> Use <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-submitTrainingJob\\\" class=\\\"xref\\\" title=\\\"Submits a training job.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution - submitTrainingJob()</span></a> to train the\\n Solution after adding it to the store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Create a dataset \\nvar myData = new sn_ml.DatasetDefinition({\\n\\n 'tableName' : 'incident',\\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\\n 'encodedQuery' : 'activeANYTHING'\\n\\n});\\n\\n// Create an solution \\nvar mySolution = new sn_ml.RegressionSolution({\\n\\n 'label': "my solution definition",\\n 'dataset' : myData,\\n 'predictedFieldName' : 'assignment_group',\\n 'inputFieldNames':['short_description']\\n\\n});\\n\\n// Add the solution to the store to later be able to retrieve it.\\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionStore-deleteObject_S\\\" id=\\\"RegressionStore-deleteObject_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionStore-deleteObject_S\\\">RegressionSolutionStore - deleteObject(String name)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Removes a specified solution object from the\\n store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionStore-deleteObject_S__table_rmj_lfr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-deleteObject_S__table_rmj_lfr_llb__entry__3\\\">Name of the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution()</span></a>\\n <span class=\\\"ph\\\">object to be deleted.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionStore-deleteObject_S__table_smj_lfr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-deleteObject_S__table_smj_lfr_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to delete a solution\\n from the store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">sn_ml.RegressionSolutionStore.deleteObject("ml_sn_global_global_solution");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionStore-get_S\\\" id=\\\"RegressionStore-get_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionStore-get_S\\\">RegressionSolutionStore - get(String name)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets a solution object from the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionStore-get_S__table_zvw_v2r_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-get_S__table_zvw_v2r_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-get_S__table_zvw_v2r_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-get_S__table_zvw_v2r_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-get_S__table_zvw_v2r_llb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-get_S__table_zvw_v2r_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-get_S__table_zvw_v2r_llb__entry__3\\\">Name of a solution in the store.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionStore-get_S__table_aww_v2r_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-get_S__table_aww_v2r_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-get_S__table_aww_v2r_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-get_S__table_aww_v2r_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-get_S__table_aww_v2r_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution</span></a>\\n <span class=\\\"ph\\\">object. Returns an error if the object does not\\n exist.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to get a solution\\n object from the store using the <span class=\\\"keyword apiname\\\">get()</span> method and view its\\n training status using the</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getActiveVersion\\\" class=\\\"xref\\\" title=\\\"Gets the active RegressionSolutionVersion object.\\\">RegressionSolution - getActiveVersion()</a> and\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html#RegressionVersion-getStatus_B\\\" class=\\\"xref\\\" title=\\\"Gets training completion status.\\\">RegressionSolutionVersion - getStatus()</a> methods.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get status\\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state":"solution_complete",\\n "percentComplete":"100",\\n "hasJobEnded":"true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionStore-getAllNames\\\" id=\\\"RegressionStore-getAllNames\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionStore-getAllNames\\\">RegressionSolutionStore - getAllNames(Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the names of all solution definition\\n records in the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Options for restricting results within the specified\\n properties.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "label": "String",\\n "domainName": "String",\\n "scope": "String"\\n};</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Optional. Label of your solution object.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Optional. Name of the domain for your solution object. Refer to <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options.scope</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Optional. Name of an <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_ApplicationScope&version=vancouver&pubname=vancouver-application-development\\\" class=\\\"xref\\\">application scope</a> for\\n your solution object.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionStore-getAllNames__table_aww_v2r_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-getAllNames__table_aww_v2r_llb__entry__2\\\">List of strings representing solution object\\n names in the store.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, the\\n <span class=\\\"keyword apiname\\\">getAllNames()</span> method returns a list of all names in the\\n store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">gs.print(JSON.stringify(JSON.parse(sn_ml.RegressionSolutionStore.getAllNames()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n "ml_x_snc_global_global_my_solution_definition_3",\\n "ml_incident_assignment",\\n "ml_x_snc_global_global_my_solution_definition",\\n "ml_x_snc_global_global_my_solution_definition_2",\\n "ml_sn_global_global_incident_service"\\n]</code></pre>\\n </div>\\n <div class=\\\"example\\\" id=\\\"RegressionStore-getAllNames__example_jzt_l5h_wnb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, the\\n <span class=\\\"keyword apiname\\\">getAllNames()</span> method returns only names associated with\\n values set in the <span class=\\\"keyword parmname\\\">options</span> parameter.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var options = {\\n 'label' : 'my solution definition',\\n 'domainName' : 'global',\\n 'scope' : 'global'\\n};\\nvar solNames = sn_ml.RegressionSolutionStore.getAllNames(options);\\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n "ml_x_snc_global_global_my_solution_definition"\\n]</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionStore-update_S_O\\\" id=\\\"RegressionStore-update_S_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionStore-update_S_O\\\">RegressionSolutionStore - update(String name, Object mlSolution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Replaces an existing object in the store with the\\n object passed as a parameter. The object name provided must be empty or\\n match.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__3\\\">Name of the solution to update.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__1\\\">mlSolution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution</span></a></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_v5p_wxr_llb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a regression solution.\\\"><span class=\\\"keyword apiname\\\">RegressionSolution()</span></a>\\n <span class=\\\"ph\\\">object properties to update.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionStore-update_S_O__table_w5p_wxr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionStore-update_S_O__table_w5p_wxr_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to update a solution\\n object in the store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var solutionUpdate = new sn_ml.RegressionSolution({\\n 'label': 'my solution definition',\\n 'dataset' : myData,\\n 'predictedFieldName' : 'assignment_group',\\n 'inputFieldNames': ['short_description']\\n});\\n\\nsn_ml.RegressionSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RegressionSolutionStore - Global\n\nEnables storing\nand retrieving solutions.\n\nThe RegressionSolutionStore\n API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\n## RegressionSolutionStore - add(Object mlSolution)\n\nAdds a new solution object to the store and returns a unique name.\n\nNote: Label values do not need to be unique. For example, if you run this method\nwith the same label 10 times, this method adds 10 different uniquely-named\nobjects to the store.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| mlSolution | RegressionSolution | RegressionSolution() object to add to the store. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | System-generated solution name. |\n\n### Example\n\nThe following example\nshows how to add a solution to the\nstore. Use RegressionSolution - submitTrainingJob() to train the\nSolution after adding it to the store.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// Create an solution \nvar mySolution = new sn_ml.RegressionSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);\n```\n\n## RegressionSolutionStore - deleteObject(String name)\n\nRemoves a specified solution object from the\nstore.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the RegressionSolution() object to be deleted. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to delete a solution\nfrom the store.\n\n```None\nsn_ml.RegressionSolutionStore.deleteObject(\"ml_sn_global_global_solution\");\n```\n\n## RegressionSolutionStore - get(String name)\n\nGets a solution object from the store.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of a solution in the store. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | RegressionSolution object. Returns an error if the object does not exist. |\n\n### Example\n\nThe following example shows how to get a solution\nobject from the store using the get() method and view its\ntraining status using the\nRegressionSolution - getActiveVersion() and\nRegressionSolutionVersion - getStatus() methods.\n\n```None\n// Get status\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## RegressionSolutionStore - getAllNames(Object options)\n\nGets the names of all solution definition\nrecords in the store.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Options for restricting results within the specified properties. ```None { \"label\": \"String\", \"domainName\": \"String\", \"scope\": \"String\" }; ``` |\n| options.label | String | Optional. Label of your solution object. |\n| options.domainName | String | Optional. Name of the domain for your solution object. Refer to Domain separation and Predictive Intelligence. |\n| options.scope | String | Optional. Name of an application scope for your solution object. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of strings representing solution object names in the store. |\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns a list of all names in the\nstore.\n\n```None\ngs.print(JSON.stringify(JSON.parse(sn_ml.RegressionSolutionStore.getAllNames()), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_my_solution_definition_3\",\n \"ml_incident_assignment\",\n \"ml_x_snc_global_global_my_solution_definition\",\n \"ml_x_snc_global_global_my_solution_definition_2\",\n \"ml_sn_global_global_incident_service\"\n]\n```\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns only names associated with\nvalues set in the options parameter.\n\n```None\nvar options = {\n 'label' : 'my solution definition',\n 'domainName' : 'global',\n 'scope' : 'global'\n};\nvar solNames = sn_ml.RegressionSolutionStore.getAllNames(options);\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_my_solution_definition\"\n]\n```\n\n## RegressionSolutionStore - update(String name, Object mlSolution)\n\nReplaces an existing object in the store with the\nobject passed as a parameter. The object name provided must be empty or\nmatch.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the solution to update. |\n| mlSolution | RegressionSolution | RegressionSolution() object properties to update. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to update a solution\nobject in the store.\n\n```None\nvar solutionUpdate = new sn_ml.RegressionSolution({\n 'label': 'my solution definition',\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames': ['short_description']\n});\n\nsn_ml.RegressionSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RegressionSolutionStore - Global\ndescription: Enables storing and retrieving solutions.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RegressionSolutionStore - Global\n\nEnables storing\nand retrieving solutions.\n\nThe RegressionSolutionStore\n API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\n## RegressionSolutionStore - add(Object mlSolution)\n\nAdds a new solution object to the store and returns a unique name.\n\nNote: Label values do not need to be unique. For example, if you run this method\nwith the same label 10 times, this method adds 10 different uniquely-named\nobjects to the store.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| mlSolution | RegressionSolution | RegressionSolution() object to add to the store. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | System-generated solution name. |\n\n### Example\n\nThe following example\nshows how to add a solution to the\nstore. Use RegressionSolution - submitTrainingJob() to train the\nSolution after adding it to the store.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// Create an solution \nvar mySolution = new sn_ml.RegressionSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.RegressionSolutionStore.add(mySolution);\n```\n\n## RegressionSolutionStore - deleteObject(String name)\n\nRemoves a specified solution object from the\nstore.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the RegressionSolution() object to be deleted. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to delete a solution\nfrom the store.\n\n```None\nsn_ml.RegressionSolutionStore.deleteObject(\"ml_sn_global_global_solution\");\n```\n\n## RegressionSolutionStore - get(String name)\n\nGets a solution object from the store.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of a solution in the store. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | RegressionSolution object. Returns an error if the object does not exist. |\n\n### Example\n\nThe following example shows how to get a solution\nobject from the store using the get() method and view its\ntraining status using the\nRegressionSolution - getActiveVersion() and\nRegressionSolutionVersion - getStatus() methods.\n\n```None\n// Get status\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## RegressionSolutionStore - getAllNames(Object options)\n\nGets the names of all solution definition\nrecords in the store.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Options for restricting results within the specified properties. ```None { \"label\": \"String\", \"domainName\": \"String\", \"scope\": \"String\" }; ``` |\n| options.label | String | Optional. Label of your solution object. |\n| options.domainName | String | Optional. Name of the domain for your solution object. Refer to Domain separation and Predictive Intelligence. |\n| options.scope | String | Optional. Name of an application scope for your solution object. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of strings representing solution object names in the store. |\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns a list of all names in the\nstore.\n\n```None\ngs.print(JSON.stringify(JSON.parse(sn_ml.RegressionSolutionStore.getAllNames()), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_my_solution_definition_3\",\n \"ml_incident_assignment\",\n \"ml_x_snc_global_global_my_solution_definition\",\n \"ml_x_snc_global_global_my_solution_definition_2\",\n \"ml_sn_global_global_incident_service\"\n]\n```\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns only names associated with\nvalues set in the options parameter.\n\n```None\nvar options = {\n 'label' : 'my solution definition',\n 'domainName' : 'global',\n 'scope' : 'global'\n};\nvar solNames = sn_ml.RegressionSolutionStore.getAllNames(options);\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_my_solution_definition\"\n]\n```\n\n## RegressionSolutionStore - update(String name, Object mlSolution)\n\nReplaces an existing object in the store with the\nobject passed as a parameter. The object name provided must be empty or\nmatch.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the solution to update. |\n| mlSolution | RegressionSolution | RegressionSolution() object properties to update. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to update a solution\nobject in the store.\n\n```None\nvar solutionUpdate = new sn_ml.RegressionSolution({\n 'label': 'my solution definition',\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames': ['short_description']\n});\n\nsn_ml.RegressionSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);\n```\n"}}},{"rowIdx":1996,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RegressionSolutionVersion - Global"},"description":{"kind":"string","value":"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_RegressionSolutionVersionAPI\"><article class=\"nested0\" aria-labelledby=\"title_RegressionSolutionVersionAPI\" id=\"RegressionSolutionVersionAPI\">\n <h1 class=\"title topictitle1\" id=\"title_RegressionSolutionVersionAPI\">RegressionSolutionVersion<span class=\"ph\"> - Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RegressionSolutionVersion</span> API is a scriptable object used in <span class=\"ph\">Predictive Intelligence</span> stores.</p>\n <p class=\"p\">This <span class=\"ph\"> API requires the <span class=\"ph\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\n within the <code class=\"ph codeph\">sn_ml</code> namespace.</span></p>\n <p class=\"p\">This API is used is used for working with solution versions based on <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" class=\"xref\" title=\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\">RegressionSolution API</a> objects in\n the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\" class=\"xref\" title=\"Enables storing and retrieving solutions.\">RegressionSolution store</a>.</p>\n <p class=\"p\">The system creates a solution version each time you train\n a solution definition. Most versions are created during scheduled solution\n training.</p>\n <div class=\"p\">Methods in this API are accessible using the following\n <span class=\"keyword apiname\">RegressionSolution</span> methods:<ul class=\"ul\" id=\"RegressionSolutionVersionAPI__ul_ycl_fzf_tlb\">\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getActiveVersion\" class=\"xref\" title=\"Gets the active RegressionSolutionVersion object.\"><span class=\"keyword apiname\">getActiveVersion()</span></a></li>\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getAllVersions\" class=\"xref\" title=\"Gets all versions of a RegressionSolution object.\"><span class=\"keyword apiname\">getAllVersions()</span></a></li>\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getLatestVersion\" class=\"xref\" title=\"Gets the latest version of a solution.\"><span class=\"keyword apiname\">getLatestVersion()</span></a></li>\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getVersion_S\" class=\"xref\" title=\"Gets a solution by provided version number.\"><span class=\"keyword apiname\">getVersion()</span></a></li>\n </ul></div>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionVersion-getProperties\" id=\"RegressionVersion-getProperties\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionVersion-getProperties\">RegressionSolutionVersion - getProperties()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets solution object\n properties</span>\n <span class=\"ph\">and version number</span>.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionVersion-getProperties__table_d2m_zwz_4lb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionVersion-getProperties__table_e2m_zwz_4lb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\">Contents of the Dataset and <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\" class=\"xref\" title=\"Creates a regression solution.\">RegressionSolution</a> version details. Results vary by object property\n setup.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "datasetProperties": {Object},\n "domainName": "String",\n "encoder": {Object}, \n "inputFieldNames": [Array],\n "isActive": "Boolean",\n "label": "String",\n "name": "String",\n "predictedFieldName": "String",\n "predictedInterval": [Array],\n "processingLanguage": "String",\n "scope": "String",\n "stopwords": [Array],\n "versionNumber": "Number"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><p class=\"p\">Lists the properties of the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html#DDef-DatasetDefinition_O\" class=\"xref\" title=\"Creates an instance of the DatasetDefinition class, enabling you to define a dataset by table name, fields, and query.\"><span class=\"keyword apiname\">DatasetDefinition()</span></a> object associated with the\n solution.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "encodedQuery": "String",\n "fieldDetails": [Array],\n "fieldNames": [Array],\n "tableName": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.tableName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Name of the table for the dataset. For\n example, <code class=\"ph codeph\">"tableName" : "Incident"</code>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">List of field names from the specified table\n as strings. For example, <code class=\"ph codeph\">"fieldNames" : ["short_description",\n "priority"]</code>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">List of JavaScript objects that specify field\n properties.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "name": "String",\n "type": "String"\n }\n]</code></pre>\n <p class=\"p\">Data\n type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Name of the field defining the type of\n information to restrict this dataset to.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Machine-learning field type.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Encoded query string in standard Glide format.\n See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\" class=\"xref\">Encoded query\n strings</a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Domain name associated with this dataset. See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.encoder</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Encoder object assigned to this\n solution.</span> See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\" class=\"xref\" title=\"Creates an encoder.\">Encoder - Encoder(Object config)</a>.<p class=\"p\">Data type:\n Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.inputFieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">List of input field names as strings. The\n model uses these fields used to make\n predictions.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.isActive</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\">Flag that indicates whether this version is\n active.<div class=\"p\">Valid values:<ul class=\"ul\" id=\"RegressionVersion-getProperties__ul_i5m_lp1_dmb\">\n <li class=\"li\">true: Version is active.</li>\n <li class=\"li\">false: Version is not active.</li>\n </ul></div>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Identifies the prediction\n task.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "label": "my first prediction"\n}</code></pre>\n <p class=\"p\">Data\n type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">System-assigned name.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.predictedFieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Identifies a field to be trained for\n predictability.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.predictedInterval</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\">Range of values specifying the prediction\n confidence level.<p class=\"p\">Data type: Array</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.processingLanguage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Processing language in two-letter ISO 639-1 language code format.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.scope</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\">Object scope. Currently the only valid value is\n <code class=\"ph codeph\">global</code>.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.stopwords</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Optional. Preset\n list of strings that the system automatically generates based on the\n <span class=\"keyword parmname\">language</span> property setting. For details, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create a custom stopwords\n list</a>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.versionNumber</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Version number of\n the</span>\n <span class=\"keyword apiname\">RegressionSolution</span> object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example gets properties of the active object\n version in the store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get properties\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "datasetProperties": {\n "encodedQuery": "",\n "fieldNames": [\n "short_description",\n "sourcedc",\n "targetdc",\n "dbsize",\n "duration"\n ],\n "tableName": "cloudinfratext"\n },\n "domainName": "global",\n "encoderProperties": {\n "datasetsProperties": [],\n "name": "wc_regression"\n },\n "inputFieldNames": [\n "short_description",\n "sourcedc",\n "targetdc",\n "dbsize"\n ],\n "isActive": "true",\n "label": "Regression Test for DB Restore",\n "name": "ml_x_snc_global_global_regression",\n "predictedFieldName": "duration",\n "processingLanguage": "en",\n "stopwords": [\n "Default English Stopwords"\n ],\n "versionNumber": "1"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionVersion-getStatus_B\" id=\"RegressionVersion-getStatus_B\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionVersion-getStatus_B\">RegressionSolutionVersion - getStatus(Boolean includeDetails)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets training completion status.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionVersion-getStatus_B__table_xfh_vbw_plb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__1\">includeDetails</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__3\"><p class=\"p\">Flag that indicates whether to return status <span class=\"keyword parmname\">details</span>.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"RegressionVersion-getStatus_B__ul_n33_ckw_plb\">\n <li class=\"li\">true: Return additional details.</li>\n <li class=\"li\">false: Do not return additional details.</li>\n </ul></div>\n <p class=\"p\">Default: False</p></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\"><span class=\"ph\">JavaScript object containing training\n status information\n for</span> a <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\" class=\"xref\" title=\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\">RegressionSolution</a>\n object.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "String",\n "percentComplete": "Number as a String",\n "hasJobEnded": "Boolean value as a String",\n "details": {Object}\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.state</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\">Training completion state. If the training\n job reaches a terminal state, the job does not leave that state. If the state is\n terminal, the <span class=\"keyword parmname\">hasJobEnded</span> property is set to\n <code class=\"ph codeph\">true</code>.<div class=\"p\">Possible values:<ul class=\"ul\" id=\"RegressionVersion-getStatus_B__ul_a5q_gh4_vlb\">\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">fetching_files_for_training</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">preparing_data</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">retry</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_cancelled</samp> (terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_complete </samp>(terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_error</samp> (terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_incomplete</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">training_request_received</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">training_request_timed_out</samp> (terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">training_solution</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">uploading_solution</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">waiting_for_training</samp></li>\n </ul></div>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.hasJobEnded</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\"><p class=\"p\">Flag that indicates whether training is complete.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"RegressionVersion-getStatus_B__ul_icy_zjx_rlb\">\n <li class=\"li\">true: Training is complete.</li>\n <li class=\"li\">false: Training is incomplete.</li>\n </ul></div>\n <p class=\"p\">Data type: Boolean value as a String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.percentComplete</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\">Number between zero and 100 representing\n training percent complete. If the completion percentage is less than 100, the job\n might be in a terminal state. For example, if training times out.<p class=\"p\">Data type:\n Number as a String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.details</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\">Object containing a list of additional\n training details.<p class=\"p\">Data type: Object</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows a successful result\n with training complete.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get status\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state":"solution_complete",\n "percentComplete":"100",\n "hasJobEnded":"true",\n "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);\n}</code></pre>\n </div>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows an unsuccessful\n result with training complete.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get status\nvar solutionName = 'ml_x_snc_global_global_regression_solution';\nvar mlSolution = sn_ml.RegressionSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state":"solution_error",\n "percentComplete":"100",\n "hasJobEnded":"true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionVersion-getVersionNumber\" id=\"RegressionVersion-getVersionNumber\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionVersion-getVersionNumber\">RegressionSolutionVersion - getVersionNumber()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the version number of</span> a solution object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__2\"><span class=\"ph\">Version number.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get a version\n number.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get version number\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Version number: 1</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RegressionVersion-predict_O_O\" id=\"RegressionVersion-predict_O_O\">\n <h2 class=\"title topictitle2\" id=\"title_RegressionVersion-predict_O_O\">RegressionSolutionVersion - predict(Object input, Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the input data for a prediction.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\">input</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\" class=\"xref\" title=\"The GlideRecord API is used for database operations.\"><span class=\"keyword apiname\">GlideRecord</span></a>\n <span class=\"ph\"> or array of JSON objects containing field names and\n values as key-value pairs.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\">Optional values for filtering prediction\n results.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "apply_threshold": Boolean,\n "top_n": Number\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\">options.apply_threshold</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\">Flag that indicates whether to check the\n threshold value for the solution and apply it to the result set.<div class=\"p\">Valid values:<ul class=\"ul\" id=\"RegressionVersion-predict_O_O__ul_f4d_xyx_slb\">\n <li class=\"li\">true: Return results in which confidence is greater than threshold.</li>\n <li class=\"li\">false: Return all results.</li>\n </ul></div>\n <p class=\"p\">Default: True</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\">options.top_n</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\"><span class=\"ph\">If provided, returns the top\n results, up to the specified number of predictions.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">JSON object containing the prediction results sorted by\n sys_id or record_number.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n <identifier>: [Array]\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\">List of objects with details for each\n prediction\n result.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\"><identifier>: [\n {\n "confidence": Number,\n "predictedSysId": "String",\n "predictedValue": "String", \n "threshold": Number\n }\n]</code></pre>\n <p class=\"p\">Data\n type: Array</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.confidence</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">Value of the confidence associated\n with the prediction. For example, 53.84.</span>\n <p class=\"p\">Data type: Number</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.predictedSysId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">The sys_id of the predicted\n value. Results can be from any table on which information is being\n predicted.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.predictedValue</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">Value representing the\n prediction result.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.threshold</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">Value of the configured threshold\n associated with the prediction.</span>\n <p class=\"p\">Data type: Number</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to display prediction\n results for a <span class=\"keyword apiname\">predict()</span> method that takes a GlideRecord by\n sys_id for input and includes optional parameters to restrict to top three results\n and exclude the threshold value.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord("incident");\ninput.get("<sys_id>");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\n \n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "<sys_id/now_GR>": [\n {\n "confidence": 62.10782320780268,\n "threshold": 20.36,\n "predictedValue": "Clone Issues",\n "predictedSysId": ""\n },\n {\n "confidence": 6.945237375770391,\n "threshold": 16.63,\n "predictedValue": "Instance Administration",\n "predictedSysId": ""\n },\n {\n "confidence": 5.321061076300759,\n "threshold": 23.7,\n "predictedValue": "Administration",\n "predictedSysId": ""\n }\n ]\n}</code></pre>\n </div>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to display prediction\n results for a <span class=\"keyword apiname\">predict()</span> method that takes an array of field\n names as key-value pairs for input and includes optional parameters to restrict to\n top three results and exclude the threshold value.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n// key-value pairs input\nvar input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "1": [\n {\n "confidence": 37.5023032262591,\n "threshold": 10.72,\n "predictedValue": "Authentication",\n "predictedSysId": ""\n },\n {\n "confidence": 24.439964862166583,\n "threshold": 23.7,\n "predictedValue": "Administration",\n "predictedSysId": ""\n },\n {\n "confidence": 11.736320486031047,\n "threshold": 100,\n "predictedValue": "Security",\n "predictedSysId": ""\n }\n ],\n "2": [\n {\n "confidence": 99,\n "threshold": 17.77,\n "predictedValue": "Email",\n "predictedSysId": ""\n },\n {\n "confidence": 3.182137005157543,\n "threshold": 10.72,\n "predictedValue": "Authentication",\n "predictedSysId": ""\n },\n {\n "confidence": 2.8773826570713514,\n "threshold": -1,\n "predictedValue": "Email (I/f)",\n "predictedSysId": ""\n }\n ]\n}</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RegressionSolutionVersion - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206685\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206685\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"RegressionSolutionVersionAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\",\n \"page_key\": 41206685,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 12981,\n \"img_count\": 0,\n \"read_time\": 5,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 1305\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RegressionSolutionVersion - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_RegressionSolutionVersionAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_RegressionSolutionVersionAPI\\\" id=\\\"RegressionSolutionVersionAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_RegressionSolutionVersionAPI\\\">RegressionSolutionVersion<span class=\\\"ph\\\"> - Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RegressionSolutionVersion</span> API is a scriptable object used in <span class=\\\"ph\\\">Predictive Intelligence</span> stores.</p>\\n <p class=\\\"p\\\">This <span class=\\\"ph\\\"> API requires the <span class=\\\"ph\\\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\\n within the <code class=\\\"ph codeph\\\">sn_ml</code> namespace.</span></p>\\n <p class=\\\"p\\\">This API is used is used for working with solution versions based on <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\\\">RegressionSolution API</a> objects in\\n the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html\\\" class=\\\"xref\\\" title=\\\"Enables storing and retrieving solutions.\\\">RegressionSolution store</a>.</p>\\n <p class=\\\"p\\\">The system creates a solution version each time you train\\n a solution definition. Most versions are created during scheduled solution\\n training.</p>\\n <div class=\\\"p\\\">Methods in this API are accessible using the following\\n <span class=\\\"keyword apiname\\\">RegressionSolution</span> methods:<ul class=\\\"ul\\\" id=\\\"RegressionSolutionVersionAPI__ul_ycl_fzf_tlb\\\">\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getActiveVersion\\\" class=\\\"xref\\\" title=\\\"Gets the active RegressionSolutionVersion object.\\\"><span class=\\\"keyword apiname\\\">getActiveVersion()</span></a></li>\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getAllVersions\\\" class=\\\"xref\\\" title=\\\"Gets all versions of a RegressionSolution object.\\\"><span class=\\\"keyword apiname\\\">getAllVersions()</span></a></li>\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getLatestVersion\\\" class=\\\"xref\\\" title=\\\"Gets the latest version of a solution.\\\"><span class=\\\"keyword apiname\\\">getLatestVersion()</span></a></li>\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-getVersion_S\\\" class=\\\"xref\\\" title=\\\"Gets a solution by provided version number.\\\"><span class=\\\"keyword apiname\\\">getVersion()</span></a></li>\\n </ul></div>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionVersion-getProperties\\\" id=\\\"RegressionVersion-getProperties\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionVersion-getProperties\\\">RegressionSolutionVersion - getProperties()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets solution object\\n properties</span>\\n <span class=\\\"ph\\\">and version number</span>.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionVersion-getProperties__table_d2m_zwz_4lb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\">Contents of the Dataset and <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html#RegressionSol-RegressionSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a regression solution.\\\">RegressionSolution</a> version details. Results vary by object property\\n setup.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "datasetProperties": {Object},\\n "domainName": "String",\\n "encoder": {Object}, \\n "inputFieldNames": [Array],\\n "isActive": "Boolean",\\n "label": "String",\\n "name": "String",\\n "predictedFieldName": "String",\\n "predictedInterval": [Array],\\n "processingLanguage": "String",\\n "scope": "String",\\n "stopwords": [Array],\\n "versionNumber": "Number"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><p class=\\\"p\\\">Lists the properties of the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html#DDef-DatasetDefinition_O\\\" class=\\\"xref\\\" title=\\\"Creates an instance of the DatasetDefinition class, enabling you to define a dataset by table name, fields, and query.\\\"><span class=\\\"keyword apiname\\\">DatasetDefinition()</span></a> object associated with the\\n solution.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "encodedQuery": "String",\\n "fieldDetails": [Array],\\n "fieldNames": [Array],\\n "tableName": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Name of the table for the dataset. For\\n example, <code class=\\\"ph codeph\\\">"tableName" : "Incident"</code>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">List of field names from the specified table\\n as strings. For example, <code class=\\\"ph codeph\\\">"fieldNames" : ["short_description",\\n "priority"]</code>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">List of JavaScript objects that specify field\\n properties.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "name": "String",\\n "type": "String"\\n }\\n]</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Name of the field defining the type of\\n information to restrict this dataset to.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Machine-learning field type.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Encoded query string in standard Glide format.\\n See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\\\" class=\\\"xref\\\">Encoded query\\n strings</a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Domain name associated with this dataset. See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.encoder</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Encoder object assigned to this\\n solution.</span> See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\\\" class=\\\"xref\\\" title=\\\"Creates an encoder.\\\">Encoder - Encoder(Object config)</a>.<p class=\\\"p\\\">Data type:\\n Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.inputFieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">List of input field names as strings. The\\n model uses these fields used to make\\n predictions.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.isActive</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\">Flag that indicates whether this version is\\n active.<div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"RegressionVersion-getProperties__ul_i5m_lp1_dmb\\\">\\n <li class=\\\"li\\\">true: Version is active.</li>\\n <li class=\\\"li\\\">false: Version is not active.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Identifies the prediction\\n task.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "label": "my first prediction"\\n}</code></pre>\\n <p class=\\\"p\\\">Data\\n type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">System-assigned name.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.predictedFieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Identifies a field to be trained for\\n predictability.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.predictedInterval</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\">Range of values specifying the prediction\\n confidence level.<p class=\\\"p\\\">Data type: Array</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.processingLanguage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Processing language in two-letter ISO 639-1 language code format.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.scope</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\">Object scope. Currently the only valid value is\\n <code class=\\\"ph codeph\\\">global</code>.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.stopwords</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Optional. Preset\\n list of strings that the system automatically generates based on the\\n <span class=\\\"keyword parmname\\\">language</span> property setting. For details, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create a custom stopwords\\n list</a>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.versionNumber</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Version number of\\n the</span>\\n <span class=\\\"keyword apiname\\\">RegressionSolution</span> object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example gets properties of the active object\\n version in the store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get properties\\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "datasetProperties": {\\n "encodedQuery": "",\\n "fieldNames": [\\n "short_description",\\n "sourcedc",\\n "targetdc",\\n "dbsize",\\n "duration"\\n ],\\n "tableName": "cloudinfratext"\\n },\\n "domainName": "global",\\n "encoderProperties": {\\n "datasetsProperties": [],\\n "name": "wc_regression"\\n },\\n "inputFieldNames": [\\n "short_description",\\n "sourcedc",\\n "targetdc",\\n "dbsize"\\n ],\\n "isActive": "true",\\n "label": "Regression Test for DB Restore",\\n "name": "ml_x_snc_global_global_regression",\\n "predictedFieldName": "duration",\\n "processingLanguage": "en",\\n "stopwords": [\\n "Default English Stopwords"\\n ],\\n "versionNumber": "1"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionVersion-getStatus_B\\\" id=\\\"RegressionVersion-getStatus_B\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionVersion-getStatus_B\\\">RegressionSolutionVersion - getStatus(Boolean includeDetails)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets training completion status.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionVersion-getStatus_B__table_xfh_vbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__1\\\">includeDetails</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__3\\\"><p class=\\\"p\\\">Flag that indicates whether to return status <span class=\\\"keyword parmname\\\">details</span>.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"RegressionVersion-getStatus_B__ul_n33_ckw_plb\\\">\\n <li class=\\\"li\\\">true: Return additional details.</li>\\n <li class=\\\"li\\\">false: Do not return additional details.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Default: False</p></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\\\"><span class=\\\"ph\\\">JavaScript object containing training\\n status information\\n for</span> a <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.\\\">RegressionSolution</a>\\n object.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "String",\\n "percentComplete": "Number as a String",\\n "hasJobEnded": "Boolean value as a String",\\n "details": {Object}\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.state</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Training completion state. If the training\\n job reaches a terminal state, the job does not leave that state. If the state is\\n terminal, the <span class=\\\"keyword parmname\\\">hasJobEnded</span> property is set to\\n <code class=\\\"ph codeph\\\">true</code>.<div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"RegressionVersion-getStatus_B__ul_a5q_gh4_vlb\\\">\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">fetching_files_for_training</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">preparing_data</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">retry</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_cancelled</samp> (terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_complete </samp>(terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_error</samp> (terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_incomplete</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">training_request_received</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">training_request_timed_out</samp> (terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">training_solution</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">uploading_solution</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">waiting_for_training</samp></li>\\n </ul></div>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.hasJobEnded</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\\\"><p class=\\\"p\\\">Flag that indicates whether training is complete.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"RegressionVersion-getStatus_B__ul_icy_zjx_rlb\\\">\\n <li class=\\\"li\\\">true: Training is complete.</li>\\n <li class=\\\"li\\\">false: Training is incomplete.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Data type: Boolean value as a String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.percentComplete</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Number between zero and 100 representing\\n training percent complete. If the completion percentage is less than 100, the job\\n might be in a terminal state. For example, if training times out.<p class=\\\"p\\\">Data type:\\n Number as a String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.details</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Object containing a list of additional\\n training details.<p class=\\\"p\\\">Data type: Object</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows a successful result\\n with training complete.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get status\\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state":"solution_complete",\\n "percentComplete":"100",\\n "hasJobEnded":"true",\\n "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);\\n}</code></pre>\\n </div>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows an unsuccessful\\n result with training complete.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get status\\nvar solutionName = 'ml_x_snc_global_global_regression_solution';\\nvar mlSolution = sn_ml.RegressionSolutionStore.get(solutionName);\\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\\n\\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state":"solution_error",\\n "percentComplete":"100",\\n "hasJobEnded":"true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionVersion-getVersionNumber\\\" id=\\\"RegressionVersion-getVersionNumber\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionVersion-getVersionNumber\\\">RegressionSolutionVersion - getVersionNumber()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the version number of</span> a solution object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__2\\\"><span class=\\\"ph\\\">Version number.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get a version\\n number.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get version number\\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\\n\\ngs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Version number: 1</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RegressionVersion-predict_O_O\\\" id=\\\"RegressionVersion-predict_O_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RegressionVersion-predict_O_O\\\">RegressionSolutionVersion - predict(Object input, Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the input data for a prediction.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\\\">input</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\\\" class=\\\"xref\\\" title=\\\"The GlideRecord API is used for database operations.\\\"><span class=\\\"keyword apiname\\\">GlideRecord</span></a>\\n <span class=\\\"ph\\\"> or array of JSON objects containing field names and\\n values as key-value pairs.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\\\">Optional values for filtering prediction\\n results.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "apply_threshold": Boolean,\\n "top_n": Number\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\\\">options.apply_threshold</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\\\">Flag that indicates whether to check the\\n threshold value for the solution and apply it to the result set.<div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"RegressionVersion-predict_O_O__ul_f4d_xyx_slb\\\">\\n <li class=\\\"li\\\">true: Return results in which confidence is greater than threshold.</li>\\n <li class=\\\"li\\\">false: Return all results.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Default: True</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__1\\\">options.top_n</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3\\\"><span class=\\\"ph\\\">If provided, returns the top\\n results, up to the specified number of predictions.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">JSON object containing the prediction results sorted by\\n sys_id or record_number.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n <identifier>: [Array]\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\\\">List of objects with details for each\\n prediction\\n result.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\"><identifier>: [\\n {\\n "confidence": Number,\\n "predictedSysId": "String",\\n "predictedValue": "String", \\n "threshold": Number\\n }\\n]</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Array</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.confidence</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">Value of the confidence associated\\n with the prediction. For example, 53.84.</span>\\n <p class=\\\"p\\\">Data type: Number</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.predictedSysId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">The sys_id of the predicted\\n value. Results can be from any table on which information is being\\n predicted.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.predictedValue</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">Value representing the\\n prediction result.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.threshold</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">Value of the configured threshold\\n associated with the prediction.</span>\\n <p class=\\\"p\\\">Data type: Number</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to display prediction\\n results for a <span class=\\\"keyword apiname\\\">predict()</span> method that takes a GlideRecord by\\n sys_id for input and includes optional parameters to restrict to top three results\\n and exclude the threshold value.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\\n\\n// single GlideRecord input\\nvar input = new GlideRecord("incident");\\ninput.get("<sys_id>");\\n\\n// configure optional parameters\\nvar options = {};\\noptions.top_n = 3;\\noptions.apply_threshold = false;\\n\\nvar results = mlSolution.getVersion(1).predict(input, options);\\n// pretty print JSON results\\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\\n \\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "<sys_id/now_GR>": [\\n {\\n "confidence": 62.10782320780268,\\n "threshold": 20.36,\\n "predictedValue": "Clone Issues",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 6.945237375770391,\\n "threshold": 16.63,\\n "predictedValue": "Instance Administration",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 5.321061076300759,\\n "threshold": 23.7,\\n "predictedValue": "Administration",\\n "predictedSysId": ""\\n }\\n ]\\n}</code></pre>\\n </div>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to display prediction\\n results for a <span class=\\\"keyword apiname\\\">predict()</span> method that takes an array of field\\n names as key-value pairs for input and includes optional parameters to restrict to\\n top three results and exclude the threshold value.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\\n// key-value pairs input\\nvar input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];\\n// configure optional parameters\\nvar options = {};\\noptions.top_n = 3;\\noptions.apply_threshold = false;\\nvar results = mlSolution.predict(input, options);\\n// pretty print JSON results\\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "1": [\\n {\\n "confidence": 37.5023032262591,\\n "threshold": 10.72,\\n "predictedValue": "Authentication",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 24.439964862166583,\\n "threshold": 23.7,\\n "predictedValue": "Administration",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 11.736320486031047,\\n "threshold": 100,\\n "predictedValue": "Security",\\n "predictedSysId": ""\\n }\\n ],\\n "2": [\\n {\\n "confidence": 99,\\n "threshold": 17.77,\\n "predictedValue": "Email",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 3.182137005157543,\\n "threshold": 10.72,\\n "predictedValue": "Authentication",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 2.8773826570713514,\\n "threshold": -1,\\n "predictedValue": "Email (I/f)",\\n "predictedSysId": ""\\n }\\n ]\\n}</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RegressionSolutionVersion - Global\n\nThe RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThis API is used is used for working with solution versions based on RegressionSolution API objects in\nthe RegressionSolution store.\n\nThe system creates a solution version each time you train\na solution definition. Most versions are created during scheduled solution\ntraining.\n\nMethods in this API are accessible using the following\nRegressionSolution methods:\n\n* getActiveVersion()\n* getAllVersions()\n* getLatestVersion()\n* getVersion()\n\n## RegressionSolutionVersion - getProperties()\n\nGets solution object\nproperties\nand version number.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and RegressionSolution version details. Results vary by object property setup. ```None { \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"inputFieldNames\": [Array], \"isActive\": \"Boolean\", \"label\": \"String\", \"name\": \"String\", \"predictedFieldName\": \"String\", \"predictedInterval\": [Array], \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"versionNumber\": \"Number\" } ``` |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoder | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.isActive | Flag that indicates whether this version is active.Valid values: * true: Version is active. * false: Version is not active. Data type: String |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.predictedInterval | Range of values specifying the prediction confidence level. Data type: Array |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.versionNumber | Version number of the RegressionSolution object. |\n\n### Example\n\nThe following example gets properties of the active object\nversion in the store.\n\n```None\n// Get properties\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"datasetProperties\": {\n \"encodedQuery\": \"\",\n \"fieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\",\n \"duration\"\n ],\n \"tableName\": \"cloudinfratext\"\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [],\n \"name\": \"wc_regression\"\n },\n \"inputFieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\"\n ],\n \"isActive\": \"true\",\n \"label\": \"Regression Test for DB Restore\",\n \"name\": \"ml_x_snc_global_global_regression\",\n \"predictedFieldName\": \"duration\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"versionNumber\": \"1\"\n}\n```\n\n## RegressionSolutionVersion - getStatus(Boolean includeDetails)\n\nGets training completion status.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| includeDetails | Boolean | Flag that indicates whether to return status details. Valid values: * true: Return additional details. * false: Do not return additional details. Default: False |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object containing training status information for a RegressionSolution object. ```None { \"state\": \"String\", \"percentComplete\": \"Number as a String\", \"hasJobEnded\": \"Boolean value as a String\", \"details\": {Object} } ``` |\n| <Object>.state | Training completion state. If the training job reaches a terminal state, the job does not leave that state. If the state is terminal, the hasJobEnded property is set to `true`.Possible values: * `fetching_files_for_training` * `preparing_data` * `retry` * `solution_cancelled` (terminal) * `solution_complete` (terminal) * `solution_error` (terminal) * `solution_incomplete` * `training_request_received` * `training_request_timed_out` (terminal) * `training_solution` * `uploading_solution` * `waiting_for_training` Data type: String |\n| <Object>.hasJobEnded | Flag that indicates whether training is complete. Valid values: * true: Training is complete. * false: Training is incomplete. Data type: Boolean value as a String |\n| <Object>.percentComplete | Number between zero and 100 representing training percent complete. If the completion percentage is less than 100, the job might be in a terminal state. For example, if training times out. Data type: Number as a String |\n| <Object>.details | Object containing a list of additional training details. Data type: Object |\n\n### Example\n\nThe following example shows a successful result\nwith training complete.\n\n```None\n// Get status\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\",\n \"details\":{\"stepLabel\":\"Solution Complete\"} // This information is only returned if getStatus(true);\n}\n```\n\n### Example\n\nThe following example shows an unsuccessful\nresult with training complete.\n\n```None\n// Get status\nvar solutionName = 'ml_x_snc_global_global_regression_solution';\nvar mlSolution = sn_ml.RegressionSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_error\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## RegressionSolutionVersion - getVersionNumber()\n\nGets the version number of a solution object.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | Version number. |\n\n### Example\n\nThe following example shows how to get a version\nnumber.\n\n```None\n// Get version number\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(\"Version number: \"+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));\n```\n\nOutput:\n\n```None\nVersion number: 1\n```\n\n## RegressionSolutionVersion - predict(Object input, Object options)\n\nGets the input data for a prediction.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| input | Object | GlideRecord or array of JSON objects containing field names and values as key-value pairs. |\n| options | Object | Optional values for filtering prediction results. ```None { \"apply_threshold\": Boolean, \"top_n\": Number } ``` |\n| options.apply\\_threshold | Boolean | Flag that indicates whether to check the threshold value for the solution and apply it to the result set.Valid values: * true: Return results in which confidence is greater than threshold. * false: Return all results. Default: True |\n| options.top\\_n | Number | If provided, returns the top results, up to the specified number of predictions. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | JSON object containing the prediction results sorted by sys\\_id or record\\_number. ```None { <identifier>: [Array] } ``` |\n| <Object>.<identifier> | List of objects with details for each prediction result. ```None <identifier>: [ { \"confidence\": Number, \"predictedSysId\": \"String\", \"predictedValue\": \"String\", \"threshold\": Number } ] ``` Data type: Array |\n| <Object>.<identifier>.<object>.confidence | Value of the confidence associated with the prediction. For example, 53.84. Data type: Number |\n| <Object>.<identifier>.<object>.predictedSysId | The sys\\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String |\n| <Object>.<identifier>.<object>.predictedValue | Value representing the prediction result. Data type: String |\n| <Object>.<identifier>.<object>.threshold | Value of the configured threshold associated with the prediction. Data type: Number |\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes a GlideRecord by\nsys\\_id for input and includes optional parameters to restrict to top three results\nand exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord(\"incident\");\ninput.get(\"<sys_id>\");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"<sys_id/now_GR>\": [\n {\n \"confidence\": 62.10782320780268,\n \"threshold\": 20.36,\n \"predictedValue\": \"Clone Issues\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 6.945237375770391,\n \"threshold\": 16.63,\n \"predictedValue\": \"Instance Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 5.321061076300759,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes an array of field\nnames as key-value pairs for input and includes optional parameters to restrict to\ntop three results and exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n// key-value pairs input\nvar input = [{\"short_description\":\"my email is not working\"}, {short_description:\"need help with password\"}];\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"1\": [\n {\n \"confidence\": 37.5023032262591,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 24.439964862166583,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 11.736320486031047,\n \"threshold\": 100,\n \"predictedValue\": \"Security\",\n \"predictedSysId\": \"\"\n }\n ],\n \"2\": [\n {\n \"confidence\": 99,\n \"threshold\": 17.77,\n \"predictedValue\": \"Email\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 3.182137005157543,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 2.8773826570713514,\n \"threshold\": -1,\n \"predictedValue\": \"Email (I/f)\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RegressionSolutionVersion - Global\ndescription: The RegressionSolutionVersion API is a scriptable object used in Predictive\n Intelligence stores.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RegressionSolutionVersion - Global\n\nThe RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThis API is used is used for working with solution versions based on RegressionSolution API objects in\nthe RegressionSolution store.\n\nThe system creates a solution version each time you train\na solution definition. Most versions are created during scheduled solution\ntraining.\n\nMethods in this API are accessible using the following\nRegressionSolution methods:\n\n* getActiveVersion()\n* getAllVersions()\n* getLatestVersion()\n* getVersion()\n\n## RegressionSolutionVersion - getProperties()\n\nGets solution object\nproperties\nand version number.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and RegressionSolution version details. Results vary by object property setup. ```None { \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"inputFieldNames\": [Array], \"isActive\": \"Boolean\", \"label\": \"String\", \"name\": \"String\", \"predictedFieldName\": \"String\", \"predictedInterval\": [Array], \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"versionNumber\": \"Number\" } ``` |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoder | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.isActive | Flag that indicates whether this version is active.Valid values: * true: Version is active. * false: Version is not active. Data type: String |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.predictedInterval | Range of values specifying the prediction confidence level. Data type: Array |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.versionNumber | Version number of the RegressionSolution object. |\n\n### Example\n\nThe following example gets properties of the active object\nversion in the store.\n\n```None\n// Get properties\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"datasetProperties\": {\n \"encodedQuery\": \"\",\n \"fieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\",\n \"duration\"\n ],\n \"tableName\": \"cloudinfratext\"\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [],\n \"name\": \"wc_regression\"\n },\n \"inputFieldNames\": [\n \"short_description\",\n \"sourcedc\",\n \"targetdc\",\n \"dbsize\"\n ],\n \"isActive\": \"true\",\n \"label\": \"Regression Test for DB Restore\",\n \"name\": \"ml_x_snc_global_global_regression\",\n \"predictedFieldName\": \"duration\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"versionNumber\": \"1\"\n}\n```\n\n## RegressionSolutionVersion - getStatus(Boolean includeDetails)\n\nGets training completion status.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| includeDetails | Boolean | Flag that indicates whether to return status details. Valid values: * true: Return additional details. * false: Do not return additional details. Default: False |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object containing training status information for a RegressionSolution object. ```None { \"state\": \"String\", \"percentComplete\": \"Number as a String\", \"hasJobEnded\": \"Boolean value as a String\", \"details\": {Object} } ``` |\n| <Object>.state | Training completion state. If the training job reaches a terminal state, the job does not leave that state. If the state is terminal, the hasJobEnded property is set to `true`.Possible values: * `fetching_files_for_training` * `preparing_data` * `retry` * `solution_cancelled` (terminal) * `solution_complete` (terminal) * `solution_error` (terminal) * `solution_incomplete` * `training_request_received` * `training_request_timed_out` (terminal) * `training_solution` * `uploading_solution` * `waiting_for_training` Data type: String |\n| <Object>.hasJobEnded | Flag that indicates whether training is complete. Valid values: * true: Training is complete. * false: Training is incomplete. Data type: Boolean value as a String |\n| <Object>.percentComplete | Number between zero and 100 representing training percent complete. If the completion percentage is less than 100, the job might be in a terminal state. For example, if training times out. Data type: Number as a String |\n| <Object>.details | Object containing a list of additional training details. Data type: Object |\n\n### Example\n\nThe following example shows a successful result\nwith training complete.\n\n```None\n// Get status\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\",\n \"details\":{\"stepLabel\":\"Solution Complete\"} // This information is only returned if getStatus(true);\n}\n```\n\n### Example\n\nThe following example shows an unsuccessful\nresult with training complete.\n\n```None\n// Get status\nvar solutionName = 'ml_x_snc_global_global_regression_solution';\nvar mlSolution = sn_ml.RegressionSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_error\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## RegressionSolutionVersion - getVersionNumber()\n\nGets the version number of a solution object.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | Version number. |\n\n### Example\n\nThe following example shows how to get a version\nnumber.\n\n```None\n// Get version number\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\ngs.print(\"Version number: \"+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));\n```\n\nOutput:\n\n```None\nVersion number: 1\n```\n\n## RegressionSolutionVersion - predict(Object input, Object options)\n\nGets the input data for a prediction.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| input | Object | GlideRecord or array of JSON objects containing field names and values as key-value pairs. |\n| options | Object | Optional values for filtering prediction results. ```None { \"apply_threshold\": Boolean, \"top_n\": Number } ``` |\n| options.apply\\_threshold | Boolean | Flag that indicates whether to check the threshold value for the solution and apply it to the result set.Valid values: * true: Return results in which confidence is greater than threshold. * false: Return all results. Default: True |\n| options.top\\_n | Number | If provided, returns the top results, up to the specified number of predictions. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | JSON object containing the prediction results sorted by sys\\_id or record\\_number. ```None { <identifier>: [Array] } ``` |\n| <Object>.<identifier> | List of objects with details for each prediction result. ```None <identifier>: [ { \"confidence\": Number, \"predictedSysId\": \"String\", \"predictedValue\": \"String\", \"threshold\": Number } ] ``` Data type: Array |\n| <Object>.<identifier>.<object>.confidence | Value of the confidence associated with the prediction. For example, 53.84. Data type: Number |\n| <Object>.<identifier>.<object>.predictedSysId | The sys\\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String |\n| <Object>.<identifier>.<object>.predictedValue | Value representing the prediction result. Data type: String |\n| <Object>.<identifier>.<object>.threshold | Value of the configured threshold associated with the prediction. Data type: Number |\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes a GlideRecord by\nsys\\_id for input and includes optional parameters to restrict to top three results\nand exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord(\"incident\");\ninput.get(\"<sys_id>\");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"<sys_id/now_GR>\": [\n {\n \"confidence\": 62.10782320780268,\n \"threshold\": 20.36,\n \"predictedValue\": \"Clone Issues\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 6.945237375770391,\n \"threshold\": 16.63,\n \"predictedValue\": \"Instance Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 5.321061076300759,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes an array of field\nnames as key-value pairs for input and includes optional parameters to restrict to\ntop three results and exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');\n// key-value pairs input\nvar input = [{\"short_description\":\"my email is not working\"}, {short_description:\"need help with password\"}];\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"1\": [\n {\n \"confidence\": 37.5023032262591,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 24.439964862166583,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 11.736320486031047,\n \"threshold\": 100,\n \"predictedValue\": \"Security\",\n \"predictedSysId\": \"\"\n }\n ],\n \"2\": [\n {\n \"confidence\": 99,\n \"threshold\": 17.77,\n \"predictedValue\": \"Email\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 3.182137005157543,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 2.8773826570713514,\n \"threshold\": -1,\n \"predictedValue\": \"Email (I/f)\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n"}}},{"rowIdx":1997,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RemedialActionEngine - Scoped"},"description":{"kind":"string","value":"The RemedialActionEngine API provides common methods for working with Remedial Actions."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_RemedialActionScopedAPI\"><article class=\"nested0\" aria-labelledby=\"title_RemedialActionScopedAPI\" id=\"RemedialActionScopedAPI\">\n <h1 class=\"title topictitle1\" id=\"title_RemedialActionScopedAPI\">RemedialActionEngine<span class=\"ph\"> - Scoped</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RemedialActionEngine</span> API provides common methods for working with Remedial Actions.</p>\n <div class=\"p\">This API is part of the Remedial Actions Framework. Use the <span class=\"keyword apiname\">RemedialAction</span> API to perform the following actions:<ul class=\"ul\" id=\"RemedialActionScopedAPI__ul_mx3_dyr_gxb\">\n <li class=\"li\">Kick start a Remedial Action</li>\n <li class=\"li\">Trigger the execution of a Remedial Action</li>\n <li class=\"li\">Check the authorization of logged in user to execute the Remedial Action</li>\n <li class=\"li\">Check the applicability of the Remedial Action against the target record</li>\n <li class=\"li\">Get the current execution status and output payload of the targeted Action</li>\n </ul></div>\n <p class=\"p\">This API requires the Remedial Actions Framework (com.snc.sn_reacf) store application and is provided within the <code class=\"ph codeph\">sn_reacf</code> namespace.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RemAction-beginRemed_S_S_O_S_S\" id=\"RemAction-beginRemed_S_S_O_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_RemAction-beginRemed_S_S_O_S_S\">RemedialActionEngine - beginRemediation (string remedialAction, string parentTable, string parentRecord, object actionParams, string targetRecord, string originRecord)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Starts any Remedial Action from the parent record against a target record. This method creates a new Remedial Action Execution record in a 'Ready' state.</p>\n <section class=\"section\">\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> When defining request parameters, remember that: <ul class=\"ul\" id=\"RemAction-beginRemed_S_S_O_S_S__ul_v5r_54d_3yb\">\n <li class=\"li\">If the parameter type is an object or array, define each property and its type.</li>\n <li class=\"li\">If the parameter type is GlideRecord, provide the associated table in your request.</li>\n </ul></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\">remedialAction</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\">Sys_id or internal_name or GlideRecord of the Remedial Action [sn_reacf_remedial_action] table.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\">parentTable</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\">Table name of the parent record.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\">parentRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\">Sys_id of the parent record.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\">actionParams</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\"><p class=\"p\">Optional. Map of Remedial Action parameter names and values.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n “<parameter name>”: <parameter value>\n}</code></pre>\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> Parameter value should be of type defined in Remedial Action Parameter [sn_reacf_remedial_action_parameter] table.</div></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\">targetRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\">Optional. Sys_id or GlideRecord of the configured Target table.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\">originRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\">Optional. Sys_id or GlideRecord of the Remedial Action Origin [sn_reacf_remedial_action_origin] table.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\"><pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "statusCode": "String",\n "actionExecutionRequestId": "String",\n "parentRecord": "String",\n "parentTable": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\"><Object>.statusCode</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\">Status code of the Remedial Action execution request i.e. successful, duplicate_request or failed</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\"><Object>.actionExecutionRequestId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\">Sys_id of the new Remedial Action Execution record or duplicate concurrent Remedial Action Execution record</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\"><Object>.parentRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\">Sys_id of the Parent record of the duplicate concurrent Remedial Action Execution record.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\"><Object>.parentTable</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\">Table name of the Parent record of the duplicate concurrent Remedial Action Execution record.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to start any Remedial Action. Here, Remedial Action uses a CI Action internally to kill a process on a CI.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var remedialAction = "9ef9924c436521101a24ff53e9b8f2d2" //sys_id of the Action\nvar parentTable = "incident"; //table name of the Parent record\nvar parentRecord = "62733787871e25105763ec6d0ebb3579" //sys_id of the Parent record\nvar actionParams = {\n process_id: "322113"\n}\nvar targetRecord = "af57a3418775e5105763ec6d0ebb356d"; //sys_id of the Target record\nvar originRecord = "26e78022c3d525104f1a722e3f40dd99"; //sys_id of the Origin record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar response = remedialActionEngine.beginRemediation(remedialAction, parentTable, parentRecord, actionParams, targetRecord, originRecord);\n \ngs.info(JSON.stringify(response));\n</code></pre>\n <p class=\"p\">Output object:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Case 1 :successful : \n{\n ‘statusCode’: ‘successful’,\n ‘actionExecutionRequestId: ‘979b6060a5954300964fa3aa92874155’\n\n}\n\nCase 2 :Duplicate : \n{\n ‘statusCode’: ‘duplicate_request,\n ‘actionExecutionRequestId’: ‘552c48888c033300964f4932b03eb092’,\n ‘parentRecord’ : ‘1a14620f973be110539e35d11153afc8’,\n ‘parentTable’: ‘incident’\n\n}\n\nCase 3 : Failed \n{\n ‘statusCode’: ‘failed,\n}\n</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RemAction-canCancel_S\" id=\"RemAction-canCancel_S\">\n <h2 class=\"title topictitle2\" id=\"title_RemAction-canCancel_S\">RemedialActionEngine - canCancel(remedialActionExecution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">This method is used to check if the current user can or cannot cancel the given Remedial Action execution.</p>\n <section class=\"section\">\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> When defining request parameters, remember that: <ul class=\"ul\" id=\"RemAction-canCancel_S__ul_v5r_54d_3yb\">\n <li class=\"li\">If the parameter type is an object or array, define each property and its type.</li>\n <li class=\"li\">If the parameter type is GlideRecord, provide the associated table in your request.</li>\n </ul></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RemAction-canCancel_S__table_lkw_xrd_3yb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__1\">remedialActionExecution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__3\">Sys_id or GlideRecord of the Remedial Action execution [sn_reacf_remedial_action_execution] table.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RemAction-canCancel_S__table_mkw_xrd_3yb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__2\"><p class=\"p\">Flag that indicates whether the Remedial Action execution request can or cannot be canceled.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"RemAction-canCancel_S__ul_wxm_psd_3yb\">\n <li class=\"li\">true: The specified Remedial Action execution request can be canceled.</li>\n <li class=\"li\">false: The specified Remedial Action execution request cannot be canceled.</li>\n </ul></div></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to validate whether the current user can cancel any Remedial Action Execution in its current state.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var remedialActionExecutionId = "9ef9924c436521101a24ff53e9b8f2d2" //sys_id of sn_reacf_remedia_action_execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar canCancel = remedialActionEngine.canCancel(remedialActionExecutionId)\n\ngs.info("canCancel: " + canCancel);\n</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">canCancel: true</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RemAction-cancelExecution_S\" id=\"RemAction-cancelExecution_S\">\n <h2 class=\"title topictitle2\" id=\"title_RemAction-cancelExecution_S\">RemedialActionEngine - cancelExecution(remedialActionExecution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Cancels a Remedial Action execution request, then updates the execution record to the state ‘cancelled’ and returns true upon success.</p>\n <section class=\"section\">\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> When defining request parameters, remember that: <ul class=\"ul\" id=\"RemAction-cancelExecution_S__ul_v5r_54d_3yb\">\n <li class=\"li\">If the parameter type is an object or array, define each property and its type.</li>\n <li class=\"li\">If the parameter type is GlideRecord, provide the associated table in your request.</li>\n </ul></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RemAction-cancelExecution_S__table_lkw_xrd_3yb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__1\">remedialActionExecution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__3\">Sys_id or GlideRecord of the Remedial Action execution [sn_reacf_remedial_action_execution] table.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RemAction-cancelExecution_S__table_mkw_xrd_3yb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__2\"><p class=\"p\">Flag that indicates whether the Remedial Action execution request can or cannot be canceled.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"RemAction-cancelExecution_S__ul_wxm_psd_3yb\">\n <li class=\"li\">true: The specified Remedial Action execution request is canceled successfully. A status of true updates the execution record to the state ‘cancelled'.</li>\n <li class=\"li\">false: The specified Remedial Action execution request is not canceled successfully.</li>\n </ul></div></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to cancel any Remedial Action Execution from its current state.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var remedialActionExecutionId = "9ef9924c436521101a24ff53e9b8f2d2" //sys_id of sn_reacf_remedia_action_execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar cancelExecution = remedialActionEngine.cancelExecution(remedialActionExecutionId)\n\ngs.info(‘cancelExecution: ’ + cancelExecution);</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">cancelExecution : true</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RemAction-executeRemedialAction_S\" id=\"RemAction-executeRemedialAction_S\">\n <h2 class=\"title topictitle2\" id=\"title_RemAction-executeRemedialAction_S\">RemedialActionEngine - executeRemedialAction (string remedialActionExecution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Triggers any Remedial Action execution that was started and is currently in Ready state. This method starts the targeted Action (e.g. CI Action) and moves the Remedial Action Execution state to 'In Progress'.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__1\">remedialActionExecution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__3\">Sys_id or GlideRecord of the Remedial Action Execution [sn_reacf_remedial_action_execution] table.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__2\"><p class=\"p\">Object contains the action_execution_table and action_execution_id of the Remedial Action execution.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n “action_execution_table”: “String”,\n “action_execution_id”: “Sys_id”\n}\n</code></pre></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to execute any Remedial Action.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var remedialActionExecution = "8ed58be387d2a5100295ebd73cbb35a3"; //Sys_id of the Remedial Action Execution record \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar response = remedialActionEngine.executeRemedialAction(remedialActionExecution); \ngs.info("Response: " + JSON.stringify(response, null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{ \n "action_execution_table": "sn_cimaf_action_request", \n "action_execution_id": "2d7843a787d2a5100295ebd73cbb35d4" \n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RemAction-getRemedialActionOutput_S\" id=\"RemAction-getRemedialActionOutput_S\">\n <h2 class=\"title topictitle2\" id=\"title_RemAction-getRemedialActionOutput_S\">RemedialActionEngine - getRemedialActionOutput (string remedialActionExecution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the current execution status and output payload of the targeted Action.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__1\">remedialActionExecution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__3\">Sys_id or GlideRecord of the Remedial Action Execution [sn_reacf_remedial_action_execution] table.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__2\"><p class=\"p\">Object contains the status object having value and display value of the target Action status, and payload array having the target Action outputs executed as part of the Remedial Action execution.</p>\n <p class=\"p\">Data type: String</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "status": {\n "value": "completed",\n "displayValue": "Completed"\n },\n "payload": [\n "{\\"output\\":\\"SUCCESS: The process with PID 19604 has been terminated.\\\\r\\\\n\\",\\"cmd\\":\\"taskkill /pid 19604 /f\\"}"\n ]\n}</code></pre></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get current execution status and output payload of the targeted Action.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var remedialActionExecution = "8ed58be387d2a5100295ebd73cbb35a3"; //sys_id of the Remedial Action Execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar response = remedialActionEngine.getRemedialActionOutput(remedialActionExecution);\n\ngs.info("Response: " + JSON.stringify(response, null, 2));\n</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "status": {\n "value": "completed",\n "displayValue": "Completed"\n },\n "payload": [\n "{\\"output\\":\\"SUCCESS: The process with PID 19604 has been terminated.\\\\r\\\\n\\",\\"cmd\\":\\"taskkill /pid 19604 /f\\"}"\n ]\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RemAction-isApplicable_S_S\" id=\"RemAction-isApplicable_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_RemAction-isApplicable_S_S\">RemedialActionEngine - isApplicable (string remedialAction, string targetRecord)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Checks the applicability of any Remedial Action against a target record.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__1\">remedialAction</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__3\">Sys_id or internal_name or GlideRecord of the Remedial Action [sn_reacf_remedial_action] table.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__1\">targetRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__3\">Sys_id or GlideRecord of the configured Target table.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__2\"><div class=\"p\">Flag that indicates the target record's applicability for the Remedial Action.<ul class=\"ul\" id=\"RemAction-isApplicable_S_S__ul_tfw_lds_gxb\">\n <li class=\"li\">true: the Remedial Action is applicable to the specified target record.</li>\n <li class=\"li\">false: the Remedial Action is not applicable to the specified target record.</li>\n </ul></div></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to check applicability of any Remedial Action against a target record.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var remedialAction = "9ef9924c436521101a24ff53e9b8f2d2"; //Sys_id of the Remedial Action Execution record \nvar targetRecord = "df3799a387a921100295ebd73cbb35c4"; //Sys_id of the Target Record \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar isApplicable = remedialActionEngine.isApplicable(remedialAction, targetRecord); \ngs.info("Is applicable: " + isApplicable);</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Is applicable: true</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RemAction-isAuthorized_S\" id=\"RemAction-isAuthorized_S\">\n <h2 class=\"title topictitle2\" id=\"title_RemAction-isAuthorized_S\">RemedialActionEngine - isAuthorized(string remedialAction)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Checks if the user is authorized to execute the Remedial Action.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RemAction-isAuthorized_S__table_wpy_jzr_gxb\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__1\">remedialAction</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__2\">String or GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__3\">Sys_id or internal_name or GlideRecord of the Remedial Action [sn_reacf_remedial_action] table.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RemAction-isAuthorized_S__table_xpy_jzr_gxb\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__2\"><p class=\"p\">Flag that indicates the resulting success status of the user's authorization.</p>\n <ul class=\"ul\" id=\"RemAction-isAuthorized_S__ul_wzf_lbs_gxb\">\n <li class=\"li\">true: The user's authorization is successful.</li>\n <li class=\"li\">false: The user's authorization is unsuccessful.</li>\n </ul></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to check authorization to execute any Remedial Action.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var actionSysId = "e62f550843e121101a24ff53e9b8f23b"; //Sys_id of the Action \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar isAuthorized = remedialActionEngine.isAuthorized(actionSysId); \ngs.info("Is user authorized: " + isAuthorized);</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Is user authorized: true</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RemedialActionEngine - Scoped</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-02T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206688\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206688\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"RemedialActionScopedAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RemedialActionEngine API provides common methods for working with Remedial Actions.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\",\n \"page_key\": 41206688,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 11021,\n \"img_count\": 0,\n \"read_time\": 5,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 1291\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RemedialActionEngine - Scoped\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_RemedialActionScopedAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_RemedialActionScopedAPI\\\" id=\\\"RemedialActionScopedAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_RemedialActionScopedAPI\\\">RemedialActionEngine<span class=\\\"ph\\\"> - Scoped</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RemedialActionEngine</span> API provides common methods for working with Remedial Actions.</p>\\n <div class=\\\"p\\\">This API is part of the Remedial Actions Framework. Use the <span class=\\\"keyword apiname\\\">RemedialAction</span> API to perform the following actions:<ul class=\\\"ul\\\" id=\\\"RemedialActionScopedAPI__ul_mx3_dyr_gxb\\\">\\n <li class=\\\"li\\\">Kick start a Remedial Action</li>\\n <li class=\\\"li\\\">Trigger the execution of a Remedial Action</li>\\n <li class=\\\"li\\\">Check the authorization of logged in user to execute the Remedial Action</li>\\n <li class=\\\"li\\\">Check the applicability of the Remedial Action against the target record</li>\\n <li class=\\\"li\\\">Get the current execution status and output payload of the targeted Action</li>\\n </ul></div>\\n <p class=\\\"p\\\">This API requires the Remedial Actions Framework (com.snc.sn_reacf) store application and is provided within the <code class=\\\"ph codeph\\\">sn_reacf</code> namespace.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RemAction-beginRemed_S_S_O_S_S\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RemAction-beginRemed_S_S_O_S_S\\\">RemedialActionEngine - beginRemediation (string remedialAction, string parentTable, string parentRecord, object actionParams, string targetRecord, string originRecord)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Starts any Remedial Action from the parent record against a target record. This method creates a new Remedial Action Execution record in a 'Ready' state.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> When defining request parameters, remember that: <ul class=\\\"ul\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__ul_v5r_54d_3yb\\\">\\n <li class=\\\"li\\\">If the parameter type is an object or array, define each property and its type.</li>\\n <li class=\\\"li\\\">If the parameter type is GlideRecord, provide the associated table in your request.</li>\\n </ul></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\\\">remedialAction</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\\\">Sys_id or internal_name or GlideRecord of the Remedial Action [sn_reacf_remedial_action] table.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\\\">parentTable</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\\\">Table name of the parent record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\\\">parentRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\\\">Sys_id of the parent record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\\\">actionParams</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\\\"><p class=\\\"p\\\">Optional. Map of Remedial Action parameter names and values.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n “<parameter name>”: <parameter value>\\n}</code></pre>\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Parameter value should be of type defined in Remedial Action Parameter [sn_reacf_remedial_action_parameter] table.</div></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\\\">targetRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\\\">Optional. Sys_id or GlideRecord of the configured Target table.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__1\\\">originRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_dcp_cgs_gxb__entry__3\\\">Optional. Sys_id or GlideRecord of the Remedial Action Origin [sn_reacf_remedial_action_origin] table.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\\\"><pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "statusCode": "String",\\n "actionExecutionRequestId": "String",\\n "parentRecord": "String",\\n "parentTable": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\\\"><Object>.statusCode</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\\\">Status code of the Remedial Action execution request i.e. successful, duplicate_request or failed</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\\\"><Object>.actionExecutionRequestId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\\\">Sys_id of the new Remedial Action Execution record or duplicate concurrent Remedial Action Execution record</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\\\"><Object>.parentRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\\\">Sys_id of the Parent record of the duplicate concurrent Remedial Action Execution record.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__1\\\"><Object>.parentTable</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-beginRemed_S_S_O_S_S__table_ecp_cgs_gxb__entry__2\\\">Table name of the Parent record of the duplicate concurrent Remedial Action Execution record.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to start any Remedial Action. Here, Remedial Action uses a CI Action internally to kill a process on a CI.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var remedialAction = "9ef9924c436521101a24ff53e9b8f2d2" //sys_id of the Action\\nvar parentTable = "incident"; //table name of the Parent record\\nvar parentRecord = "62733787871e25105763ec6d0ebb3579" //sys_id of the Parent record\\nvar actionParams = {\\n process_id: "322113"\\n}\\nvar targetRecord = "af57a3418775e5105763ec6d0ebb356d"; //sys_id of the Target record\\nvar originRecord = "26e78022c3d525104f1a722e3f40dd99"; //sys_id of the Origin record\\n\\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\\nvar response = remedialActionEngine.beginRemediation(remedialAction, parentTable, parentRecord, actionParams, targetRecord, originRecord);\\n \\ngs.info(JSON.stringify(response));\\n</code></pre>\\n <p class=\\\"p\\\">Output object:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Case 1 :successful : \\n{\\n ‘statusCode’: ‘successful’,\\n ‘actionExecutionRequestId: ‘979b6060a5954300964fa3aa92874155’\\n\\n}\\n\\nCase 2 :Duplicate : \\n{\\n ‘statusCode’: ‘duplicate_request,\\n ‘actionExecutionRequestId’: ‘552c48888c033300964f4932b03eb092’,\\n ‘parentRecord’ : ‘1a14620f973be110539e35d11153afc8’,\\n ‘parentTable’: ‘incident’\\n\\n}\\n\\nCase 3 : Failed \\n{\\n ‘statusCode’: ‘failed,\\n}\\n</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RemAction-canCancel_S\\\" id=\\\"RemAction-canCancel_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RemAction-canCancel_S\\\">RemedialActionEngine - canCancel(remedialActionExecution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">This method is used to check if the current user can or cannot cancel the given Remedial Action execution.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> When defining request parameters, remember that: <ul class=\\\"ul\\\" id=\\\"RemAction-canCancel_S__ul_v5r_54d_3yb\\\">\\n <li class=\\\"li\\\">If the parameter type is an object or array, define each property and its type.</li>\\n <li class=\\\"li\\\">If the parameter type is GlideRecord, provide the associated table in your request.</li>\\n </ul></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RemAction-canCancel_S__table_lkw_xrd_3yb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__1\\\">remedialActionExecution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-canCancel_S__table_lkw_xrd_3yb__entry__3\\\">Sys_id or GlideRecord of the Remedial Action execution [sn_reacf_remedial_action_execution] table.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RemAction-canCancel_S__table_mkw_xrd_3yb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-canCancel_S__table_mkw_xrd_3yb__entry__2\\\"><p class=\\\"p\\\">Flag that indicates whether the Remedial Action execution request can or cannot be canceled.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"RemAction-canCancel_S__ul_wxm_psd_3yb\\\">\\n <li class=\\\"li\\\">true: The specified Remedial Action execution request can be canceled.</li>\\n <li class=\\\"li\\\">false: The specified Remedial Action execution request cannot be canceled.</li>\\n </ul></div></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to validate whether the current user can cancel any Remedial Action Execution in its current state.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var remedialActionExecutionId = "9ef9924c436521101a24ff53e9b8f2d2" //sys_id of sn_reacf_remedia_action_execution record\\n\\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\\nvar canCancel = remedialActionEngine.canCancel(remedialActionExecutionId)\\n\\ngs.info("canCancel: " + canCancel);\\n</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">canCancel: true</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RemAction-cancelExecution_S\\\" id=\\\"RemAction-cancelExecution_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RemAction-cancelExecution_S\\\">RemedialActionEngine - cancelExecution(remedialActionExecution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Cancels a Remedial Action execution request, then updates the execution record to the state ‘cancelled’ and returns true upon success.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> When defining request parameters, remember that: <ul class=\\\"ul\\\" id=\\\"RemAction-cancelExecution_S__ul_v5r_54d_3yb\\\">\\n <li class=\\\"li\\\">If the parameter type is an object or array, define each property and its type.</li>\\n <li class=\\\"li\\\">If the parameter type is GlideRecord, provide the associated table in your request.</li>\\n </ul></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RemAction-cancelExecution_S__table_lkw_xrd_3yb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__1\\\">remedialActionExecution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-cancelExecution_S__table_lkw_xrd_3yb__entry__3\\\">Sys_id or GlideRecord of the Remedial Action execution [sn_reacf_remedial_action_execution] table.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RemAction-cancelExecution_S__table_mkw_xrd_3yb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-cancelExecution_S__table_mkw_xrd_3yb__entry__2\\\"><p class=\\\"p\\\">Flag that indicates whether the Remedial Action execution request can or cannot be canceled.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"RemAction-cancelExecution_S__ul_wxm_psd_3yb\\\">\\n <li class=\\\"li\\\">true: The specified Remedial Action execution request is canceled successfully. A status of true updates the execution record to the state ‘cancelled'.</li>\\n <li class=\\\"li\\\">false: The specified Remedial Action execution request is not canceled successfully.</li>\\n </ul></div></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to cancel any Remedial Action Execution from its current state.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var remedialActionExecutionId = "9ef9924c436521101a24ff53e9b8f2d2" //sys_id of sn_reacf_remedia_action_execution record\\n\\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\\nvar cancelExecution = remedialActionEngine.cancelExecution(remedialActionExecutionId)\\n\\ngs.info(‘cancelExecution: ’ + cancelExecution);</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">cancelExecution : true</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RemAction-executeRemedialAction_S\\\" id=\\\"RemAction-executeRemedialAction_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RemAction-executeRemedialAction_S\\\">RemedialActionEngine - executeRemedialAction (string remedialActionExecution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Triggers any Remedial Action execution that was started and is currently in Ready state. This method starts the targeted Action (e.g. CI Action) and moves the Remedial Action Execution state to 'In Progress'.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__1\\\">remedialActionExecution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-executeRemedialAction_S__table_htl_mfs_gxb__entry__3\\\">Sys_id or GlideRecord of the Remedial Action Execution [sn_reacf_remedial_action_execution] table.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-executeRemedialAction_S__table_itl_mfs_gxb__entry__2\\\"><p class=\\\"p\\\">Object contains the action_execution_table and action_execution_id of the Remedial Action execution.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n “action_execution_table”: “String”,\\n “action_execution_id”: “Sys_id”\\n}\\n</code></pre></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to execute any Remedial Action.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var remedialActionExecution = "8ed58be387d2a5100295ebd73cbb35a3"; //Sys_id of the Remedial Action Execution record \\n \\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \\nvar response = remedialActionEngine.executeRemedialAction(remedialActionExecution); \\ngs.info("Response: " + JSON.stringify(response, null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{ \\n "action_execution_table": "sn_cimaf_action_request", \\n "action_execution_id": "2d7843a787d2a5100295ebd73cbb35d4" \\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RemAction-getRemedialActionOutput_S\\\" id=\\\"RemAction-getRemedialActionOutput_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RemAction-getRemedialActionOutput_S\\\">RemedialActionEngine - getRemedialActionOutput (string remedialActionExecution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the current execution status and output payload of the targeted Action.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__1\\\">remedialActionExecution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-getRemedialActionOutput_S__table_rtg_32s_gxb__entry__3\\\">Sys_id or GlideRecord of the Remedial Action Execution [sn_reacf_remedial_action_execution] table.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-getRemedialActionOutput_S__table_stg_32s_gxb__entry__2\\\"><p class=\\\"p\\\">Object contains the status object having value and display value of the target Action status, and payload array having the target Action outputs executed as part of the Remedial Action execution.</p>\\n <p class=\\\"p\\\">Data type: String</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "status": {\\n "value": "completed",\\n "displayValue": "Completed"\\n },\\n "payload": [\\n "{\\\\"output\\\\":\\\\"SUCCESS: The process with PID 19604 has been terminated.\\\\\\\\r\\\\\\\\n\\\\",\\\\"cmd\\\\":\\\\"taskkill /pid 19604 /f\\\\"}"\\n ]\\n}</code></pre></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get current execution status and output payload of the targeted Action.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var remedialActionExecution = "8ed58be387d2a5100295ebd73cbb35a3"; //sys_id of the Remedial Action Execution record\\n\\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\\nvar response = remedialActionEngine.getRemedialActionOutput(remedialActionExecution);\\n\\ngs.info("Response: " + JSON.stringify(response, null, 2));\\n</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "status": {\\n "value": "completed",\\n "displayValue": "Completed"\\n },\\n "payload": [\\n "{\\\\"output\\\\":\\\\"SUCCESS: The process with PID 19604 has been terminated.\\\\\\\\r\\\\\\\\n\\\\",\\\\"cmd\\\\":\\\\"taskkill /pid 19604 /f\\\\"}"\\n ]\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RemAction-isApplicable_S_S\\\" id=\\\"RemAction-isApplicable_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RemAction-isApplicable_S_S\\\">RemedialActionEngine - isApplicable (string remedialAction, string targetRecord)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Checks the applicability of any Remedial Action against a target record.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__1\\\">remedialAction</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__3\\\">Sys_id or internal_name or GlideRecord of the Remedial Action [sn_reacf_remedial_action] table.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__1\\\">targetRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_m4x_wcs_gxb__entry__3\\\">Sys_id or GlideRecord of the configured Target table.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isApplicable_S_S__table_n4x_wcs_gxb__entry__2\\\"><div class=\\\"p\\\">Flag that indicates the target record's applicability for the Remedial Action.<ul class=\\\"ul\\\" id=\\\"RemAction-isApplicable_S_S__ul_tfw_lds_gxb\\\">\\n <li class=\\\"li\\\">true: the Remedial Action is applicable to the specified target record.</li>\\n <li class=\\\"li\\\">false: the Remedial Action is not applicable to the specified target record.</li>\\n </ul></div></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to check applicability of any Remedial Action against a target record.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var remedialAction = "9ef9924c436521101a24ff53e9b8f2d2"; //Sys_id of the Remedial Action Execution record \\nvar targetRecord = "df3799a387a921100295ebd73cbb35c4"; //Sys_id of the Target Record \\n \\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \\nvar isApplicable = remedialActionEngine.isApplicable(remedialAction, targetRecord); \\ngs.info("Is applicable: " + isApplicable);</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Is applicable: true</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RemAction-isAuthorized_S\\\" id=\\\"RemAction-isAuthorized_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RemAction-isAuthorized_S\\\">RemedialActionEngine - isAuthorized(string remedialAction)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Checks if the user is authorized to execute the Remedial Action.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RemAction-isAuthorized_S__table_wpy_jzr_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__1\\\">remedialAction</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__2\\\">String or GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isAuthorized_S__table_wpy_jzr_gxb__entry__3\\\">Sys_id or internal_name or GlideRecord of the Remedial Action [sn_reacf_remedial_action] table.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RemAction-isAuthorized_S__table_xpy_jzr_gxb\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RemAction-isAuthorized_S__table_xpy_jzr_gxb__entry__2\\\"><p class=\\\"p\\\">Flag that indicates the resulting success status of the user's authorization.</p>\\n <ul class=\\\"ul\\\" id=\\\"RemAction-isAuthorized_S__ul_wzf_lbs_gxb\\\">\\n <li class=\\\"li\\\">true: The user's authorization is successful.</li>\\n <li class=\\\"li\\\">false: The user's authorization is unsuccessful.</li>\\n </ul></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to check authorization to execute any Remedial Action.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var actionSysId = "e62f550843e121101a24ff53e9b8f23b"; //Sys_id of the Action \\n \\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \\nvar isAuthorized = remedialActionEngine.isAuthorized(actionSysId); \\ngs.info("Is user authorized: " + isAuthorized);</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Is user authorized: true</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RemedialActionEngine - Scoped\n\nThe RemedialActionEngine API provides common methods for working with Remedial Actions.\n\nThis API is part of the Remedial Actions Framework. Use the RemedialAction API to perform the following actions:\n\n* Kick start a Remedial Action\n* Trigger the execution of a Remedial Action\n* Check the authorization of logged in user to execute the Remedial Action\n* Check the applicability of the Remedial Action against the target record\n* Get the current execution status and output payload of the targeted Action\n\nThis API requires the Remedial Actions Framework (com.snc.sn\\_reacf) store application and is provided within the `sn_reacf` namespace.\n\n## RemedialActionEngine - beginRemediation (string remedialAction, string parentTable, string parentRecord, object actionParams, string targetRecord, string originRecord)\n\nStarts any Remedial Action from the parent record against a target record. This method creates a new Remedial Action Execution record in a 'Ready' state.\n\nNote: When defining request parameters, remember that:\n\n* If the parameter type is an object or array, define each property and its type.\n* If the parameter type is GlideRecord, provide the associated table in your request.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialAction | String or GlideRecord | Sys\\_id or internal\\_name or GlideRecord of the Remedial Action [sn\\_reacf\\_remedial\\_action] table. |\n| parentTable | String | Table name of the parent record. |\n| parentRecord | String | Sys\\_id of the parent record. |\n| actionParams | Object | Optional. Map of Remedial Action parameter names and values. ```None { “<parameter name>”: <parameter value> } ``` Note: Parameter value should be of type defined in Remedial Action Parameter [sn\\_reacf\\_remedial\\_action\\_parameter] table. |\n| targetRecord | String or GlideRecord | Optional. Sys\\_id or GlideRecord of the configured Target table. |\n| originRecord | String or GlideRecord | Optional. Sys\\_id or GlideRecord of the Remedial Action Origin [sn\\_reacf\\_remedial\\_action\\_origin] table. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | ```None { \"statusCode\": \"String\", \"actionExecutionRequestId\": \"String\", \"parentRecord\": \"String\", \"parentTable\": \"String\" } ``` |\n| <Object>.statusCode | Status code of the Remedial Action execution request i.e. successful, duplicate\\_request or failed |\n| <Object>.actionExecutionRequestId | Sys\\_id of the new Remedial Action Execution record or duplicate concurrent Remedial Action Execution record |\n| <Object>.parentRecord | Sys\\_id of the Parent record of the duplicate concurrent Remedial Action Execution record. |\n| <Object>.parentTable | Table name of the Parent record of the duplicate concurrent Remedial Action Execution record. |\n\n### Example\n\nThe following example shows how to start any Remedial Action. Here, Remedial Action uses a CI Action internally to kill a process on a CI.\n\n```None\nvar remedialAction = \"9ef9924c436521101a24ff53e9b8f2d2\" //sys_id of the Action\nvar parentTable = \"incident\"; //table name of the Parent record\nvar parentRecord = \"62733787871e25105763ec6d0ebb3579\" //sys_id of the Parent record\nvar actionParams = {\n process_id: \"322113\"\n}\nvar targetRecord = \"af57a3418775e5105763ec6d0ebb356d\"; //sys_id of the Target record\nvar originRecord = \"26e78022c3d525104f1a722e3f40dd99\"; //sys_id of the Origin record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar response = remedialActionEngine.beginRemediation(remedialAction, parentTable, parentRecord, actionParams, targetRecord, originRecord);\n \ngs.info(JSON.stringify(response));\n\n```\n\nOutput object:\n\n```None\nCase 1 :successful : \n{\n ‘statusCode’: ‘successful’,\n ‘actionExecutionRequestId: ‘979b6060a5954300964fa3aa92874155’\n\n}\n\nCase 2 :Duplicate : \n{\n ‘statusCode’: ‘duplicate_request,\n ‘actionExecutionRequestId’: ‘552c48888c033300964f4932b03eb092’,\n ‘parentRecord’ : ‘1a14620f973be110539e35d11153afc8’,\n ‘parentTable’: ‘incident’\n\n}\n\nCase 3 : Failed \n{\n ‘statusCode’: ‘failed,\n}\n\n```\n\n## RemedialActionEngine - canCancel(remedialActionExecution)\n\nThis method is used to check if the current user can or cannot cancel the given Remedial Action execution.\n\nNote: When defining request parameters, remember that:\n\n* If the parameter type is an object or array, define each property and its type.\n* If the parameter type is GlideRecord, provide the associated table in your request.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates whether the Remedial Action execution request can or cannot be canceled. Valid values: * true: The specified Remedial Action execution request can be canceled. * false: The specified Remedial Action execution request cannot be canceled. |\n\n### Example\n\nThe following example shows how to validate whether the current user can cancel any Remedial Action Execution in its current state.\n\n```None\nvar remedialActionExecutionId = \"9ef9924c436521101a24ff53e9b8f2d2\" //sys_id of sn_reacf_remedia_action_execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar canCancel = remedialActionEngine.canCancel(remedialActionExecutionId)\n\ngs.info(\"canCancel: \" + canCancel);\n\n```\n\nOutput:\n\n```None\ncanCancel: true\n```\n\n## RemedialActionEngine - cancelExecution(remedialActionExecution)\n\nCancels a Remedial Action execution request, then updates the execution record to the state ‘cancelled’ and returns true upon success.\n\nNote: When defining request parameters, remember that:\n\n* If the parameter type is an object or array, define each property and its type.\n* If the parameter type is GlideRecord, provide the associated table in your request.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates whether the Remedial Action execution request can or cannot be canceled. Valid values: * true: The specified Remedial Action execution request is canceled successfully. A status of true updates the execution record to the state ‘cancelled'. * false: The specified Remedial Action execution request is not canceled successfully. |\n\n### Example\n\nThe following example shows how to cancel any Remedial Action Execution from its current state.\n\n```None\nvar remedialActionExecutionId = \"9ef9924c436521101a24ff53e9b8f2d2\" //sys_id of sn_reacf_remedia_action_execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar cancelExecution = remedialActionEngine.cancelExecution(remedialActionExecutionId)\n\ngs.info(‘cancelExecution: ’ + cancelExecution);\n```\n\nOutput:\n\n```None\ncancelExecution : true\n```\n\n## RemedialActionEngine - executeRemedialAction (string remedialActionExecution)\n\nTriggers any Remedial Action execution that was started and is currently in Ready state. This method starts the targeted Action (e.g. CI Action) and moves the Remedial Action Execution state to 'In Progress'.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action Execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | Object contains the action\\_execution\\_table and action\\_execution\\_id of the Remedial Action execution. ```None { “action_execution_table”: “String”, “action_execution_id”: “Sys_id” } ``` |\n\n### Example\n\nThe following example shows how to execute any Remedial Action.\n\n```None\nvar remedialActionExecution = \"8ed58be387d2a5100295ebd73cbb35a3\"; //Sys_id of the Remedial Action Execution record \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar response = remedialActionEngine.executeRemedialAction(remedialActionExecution); \ngs.info(\"Response: \" + JSON.stringify(response, null, 2));\n```\n\nOutput:\n\n```None\n{ \n \"action_execution_table\": \"sn_cimaf_action_request\", \n \"action_execution_id\": \"2d7843a787d2a5100295ebd73cbb35d4\" \n}\n```\n\n## RemedialActionEngine - getRemedialActionOutput (string remedialActionExecution)\n\nGets the current execution status and output payload of the targeted Action.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action Execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| Object | Object contains the status object having value and display value of the target Action status, and payload array having the target Action outputs executed as part of the Remedial Action execution. Data type: String ```None { \"status\": { \"value\": \"completed\", \"displayValue\": \"Completed\" }, \"payload\": [ \"{\\\"output\\\":\\\"SUCCESS: The process with PID 19604 has been terminated.\\\\r\\\\n\\\",\\\"cmd\\\":\\\"taskkill /pid 19604 /f\\\"}\" ] } ``` |\n\n### Example\n\nThe following example shows how to get current execution status and output payload of the targeted Action.\n\n```None\nvar remedialActionExecution = \"8ed58be387d2a5100295ebd73cbb35a3\"; //sys_id of the Remedial Action Execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar response = remedialActionEngine.getRemedialActionOutput(remedialActionExecution);\n\ngs.info(\"Response: \" + JSON.stringify(response, null, 2));\n\n```\n\nOutput:\n\n```None\n{\n \"status\": {\n \"value\": \"completed\",\n \"displayValue\": \"Completed\"\n },\n \"payload\": [\n \"{\\\"output\\\":\\\"SUCCESS: The process with PID 19604 has been terminated.\\\\r\\\\n\\\",\\\"cmd\\\":\\\"taskkill /pid 19604 /f\\\"}\"\n ]\n}\n```\n\n## RemedialActionEngine - isApplicable (string remedialAction, string targetRecord)\n\nChecks the applicability of any Remedial Action against a target record.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialAction | String or GlideRecord | Sys\\_id or internal\\_name or GlideRecord of the Remedial Action [sn\\_reacf\\_remedial\\_action] table. |\n| targetRecord | String or GlideRecord | Sys\\_id or GlideRecord of the configured Target table. |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates the target record's applicability for the Remedial Action. * true: the Remedial Action is applicable to the specified target record. * false: the Remedial Action is not applicable to the specified target record. |\n\n### Example\n\nThe following example shows how to check applicability of any Remedial Action against a target record.\n\n```None\nvar remedialAction = \"9ef9924c436521101a24ff53e9b8f2d2\"; //Sys_id of the Remedial Action Execution record \nvar targetRecord = \"df3799a387a921100295ebd73cbb35c4\"; //Sys_id of the Target Record \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar isApplicable = remedialActionEngine.isApplicable(remedialAction, targetRecord); \ngs.info(\"Is applicable: \" + isApplicable);\n```\n\nOutput:\n\n```None\nIs applicable: true\n```\n\n## RemedialActionEngine - isAuthorized(string remedialAction)\n\nChecks if the user is authorized to execute the Remedial Action.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialAction | String or GlideRecord | Sys\\_id or internal\\_name or GlideRecord of the Remedial Action [sn\\_reacf\\_remedial\\_action] table. |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates the resulting success status of the user's authorization. * true: The user's authorization is successful. * false: The user's authorization is unsuccessful. |\n\n### Example\n\nThe following example shows how to check authorization to execute any Remedial Action.\n\n```None\nvar actionSysId = \"e62f550843e121101a24ff53e9b8f23b\"; //Sys_id of the Action \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar isAuthorized = remedialActionEngine.isAuthorized(actionSysId); \ngs.info(\"Is user authorized: \" + isAuthorized);\n```\n\nOutput:\n\n```None\nIs user authorized: true\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RemedialActionEngine - Scoped\ndescription: The RemedialActionEngine API provides common methods for working with\n Remedial Actions.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RemedialActionEngine - Scoped\n\nThe RemedialActionEngine API provides common methods for working with Remedial Actions.\n\nThis API is part of the Remedial Actions Framework. Use the RemedialAction API to perform the following actions:\n\n* Kick start a Remedial Action\n* Trigger the execution of a Remedial Action\n* Check the authorization of logged in user to execute the Remedial Action\n* Check the applicability of the Remedial Action against the target record\n* Get the current execution status and output payload of the targeted Action\n\nThis API requires the Remedial Actions Framework (com.snc.sn\\_reacf) store application and is provided within the `sn_reacf` namespace.\n\n## RemedialActionEngine - beginRemediation (string remedialAction, string parentTable, string parentRecord, object actionParams, string targetRecord, string originRecord)\n\nStarts any Remedial Action from the parent record against a target record. This method creates a new Remedial Action Execution record in a 'Ready' state.\n\nNote: When defining request parameters, remember that:\n\n* If the parameter type is an object or array, define each property and its type.\n* If the parameter type is GlideRecord, provide the associated table in your request.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialAction | String or GlideRecord | Sys\\_id or internal\\_name or GlideRecord of the Remedial Action [sn\\_reacf\\_remedial\\_action] table. |\n| parentTable | String | Table name of the parent record. |\n| parentRecord | String | Sys\\_id of the parent record. |\n| actionParams | Object | Optional. Map of Remedial Action parameter names and values. ```None { “<parameter name>”: <parameter value> } ``` Note: Parameter value should be of type defined in Remedial Action Parameter [sn\\_reacf\\_remedial\\_action\\_parameter] table. |\n| targetRecord | String or GlideRecord | Optional. Sys\\_id or GlideRecord of the configured Target table. |\n| originRecord | String or GlideRecord | Optional. Sys\\_id or GlideRecord of the Remedial Action Origin [sn\\_reacf\\_remedial\\_action\\_origin] table. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | ```None { \"statusCode\": \"String\", \"actionExecutionRequestId\": \"String\", \"parentRecord\": \"String\", \"parentTable\": \"String\" } ``` |\n| <Object>.statusCode | Status code of the Remedial Action execution request i.e. successful, duplicate\\_request or failed |\n| <Object>.actionExecutionRequestId | Sys\\_id of the new Remedial Action Execution record or duplicate concurrent Remedial Action Execution record |\n| <Object>.parentRecord | Sys\\_id of the Parent record of the duplicate concurrent Remedial Action Execution record. |\n| <Object>.parentTable | Table name of the Parent record of the duplicate concurrent Remedial Action Execution record. |\n\n### Example\n\nThe following example shows how to start any Remedial Action. Here, Remedial Action uses a CI Action internally to kill a process on a CI.\n\n```None\nvar remedialAction = \"9ef9924c436521101a24ff53e9b8f2d2\" //sys_id of the Action\nvar parentTable = \"incident\"; //table name of the Parent record\nvar parentRecord = \"62733787871e25105763ec6d0ebb3579\" //sys_id of the Parent record\nvar actionParams = {\n process_id: \"322113\"\n}\nvar targetRecord = \"af57a3418775e5105763ec6d0ebb356d\"; //sys_id of the Target record\nvar originRecord = \"26e78022c3d525104f1a722e3f40dd99\"; //sys_id of the Origin record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar response = remedialActionEngine.beginRemediation(remedialAction, parentTable, parentRecord, actionParams, targetRecord, originRecord);\n \ngs.info(JSON.stringify(response));\n\n```\n\nOutput object:\n\n```None\nCase 1 :successful : \n{\n ‘statusCode’: ‘successful’,\n ‘actionExecutionRequestId: ‘979b6060a5954300964fa3aa92874155’\n\n}\n\nCase 2 :Duplicate : \n{\n ‘statusCode’: ‘duplicate_request,\n ‘actionExecutionRequestId’: ‘552c48888c033300964f4932b03eb092’,\n ‘parentRecord’ : ‘1a14620f973be110539e35d11153afc8’,\n ‘parentTable’: ‘incident’\n\n}\n\nCase 3 : Failed \n{\n ‘statusCode’: ‘failed,\n}\n\n```\n\n## RemedialActionEngine - canCancel(remedialActionExecution)\n\nThis method is used to check if the current user can or cannot cancel the given Remedial Action execution.\n\nNote: When defining request parameters, remember that:\n\n* If the parameter type is an object or array, define each property and its type.\n* If the parameter type is GlideRecord, provide the associated table in your request.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates whether the Remedial Action execution request can or cannot be canceled. Valid values: * true: The specified Remedial Action execution request can be canceled. * false: The specified Remedial Action execution request cannot be canceled. |\n\n### Example\n\nThe following example shows how to validate whether the current user can cancel any Remedial Action Execution in its current state.\n\n```None\nvar remedialActionExecutionId = \"9ef9924c436521101a24ff53e9b8f2d2\" //sys_id of sn_reacf_remedia_action_execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar canCancel = remedialActionEngine.canCancel(remedialActionExecutionId)\n\ngs.info(\"canCancel: \" + canCancel);\n\n```\n\nOutput:\n\n```None\ncanCancel: true\n```\n\n## RemedialActionEngine - cancelExecution(remedialActionExecution)\n\nCancels a Remedial Action execution request, then updates the execution record to the state ‘cancelled’ and returns true upon success.\n\nNote: When defining request parameters, remember that:\n\n* If the parameter type is an object or array, define each property and its type.\n* If the parameter type is GlideRecord, provide the associated table in your request.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates whether the Remedial Action execution request can or cannot be canceled. Valid values: * true: The specified Remedial Action execution request is canceled successfully. A status of true updates the execution record to the state ‘cancelled'. * false: The specified Remedial Action execution request is not canceled successfully. |\n\n### Example\n\nThe following example shows how to cancel any Remedial Action Execution from its current state.\n\n```None\nvar remedialActionExecutionId = \"9ef9924c436521101a24ff53e9b8f2d2\" //sys_id of sn_reacf_remedia_action_execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar cancelExecution = remedialActionEngine.cancelExecution(remedialActionExecutionId)\n\ngs.info(‘cancelExecution: ’ + cancelExecution);\n```\n\nOutput:\n\n```None\ncancelExecution : true\n```\n\n## RemedialActionEngine - executeRemedialAction (string remedialActionExecution)\n\nTriggers any Remedial Action execution that was started and is currently in Ready state. This method starts the targeted Action (e.g. CI Action) and moves the Remedial Action Execution state to 'In Progress'.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action Execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | Object contains the action\\_execution\\_table and action\\_execution\\_id of the Remedial Action execution. ```None { “action_execution_table”: “String”, “action_execution_id”: “Sys_id” } ``` |\n\n### Example\n\nThe following example shows how to execute any Remedial Action.\n\n```None\nvar remedialActionExecution = \"8ed58be387d2a5100295ebd73cbb35a3\"; //Sys_id of the Remedial Action Execution record \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar response = remedialActionEngine.executeRemedialAction(remedialActionExecution); \ngs.info(\"Response: \" + JSON.stringify(response, null, 2));\n```\n\nOutput:\n\n```None\n{ \n \"action_execution_table\": \"sn_cimaf_action_request\", \n \"action_execution_id\": \"2d7843a787d2a5100295ebd73cbb35d4\" \n}\n```\n\n## RemedialActionEngine - getRemedialActionOutput (string remedialActionExecution)\n\nGets the current execution status and output payload of the targeted Action.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialActionExecution | String or GlideRecord | Sys\\_id or GlideRecord of the Remedial Action Execution [sn\\_reacf\\_remedial\\_action\\_execution] table. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| Object | Object contains the status object having value and display value of the target Action status, and payload array having the target Action outputs executed as part of the Remedial Action execution. Data type: String ```None { \"status\": { \"value\": \"completed\", \"displayValue\": \"Completed\" }, \"payload\": [ \"{\\\"output\\\":\\\"SUCCESS: The process with PID 19604 has been terminated.\\\\r\\\\n\\\",\\\"cmd\\\":\\\"taskkill /pid 19604 /f\\\"}\" ] } ``` |\n\n### Example\n\nThe following example shows how to get current execution status and output payload of the targeted Action.\n\n```None\nvar remedialActionExecution = \"8ed58be387d2a5100295ebd73cbb35a3\"; //sys_id of the Remedial Action Execution record\n\nvar remedialActionEngine = new sn_reacf.RemedialActionEngine();\nvar response = remedialActionEngine.getRemedialActionOutput(remedialActionExecution);\n\ngs.info(\"Response: \" + JSON.stringify(response, null, 2));\n\n```\n\nOutput:\n\n```None\n{\n \"status\": {\n \"value\": \"completed\",\n \"displayValue\": \"Completed\"\n },\n \"payload\": [\n \"{\\\"output\\\":\\\"SUCCESS: The process with PID 19604 has been terminated.\\\\r\\\\n\\\",\\\"cmd\\\":\\\"taskkill /pid 19604 /f\\\"}\"\n ]\n}\n```\n\n## RemedialActionEngine - isApplicable (string remedialAction, string targetRecord)\n\nChecks the applicability of any Remedial Action against a target record.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialAction | String or GlideRecord | Sys\\_id or internal\\_name or GlideRecord of the Remedial Action [sn\\_reacf\\_remedial\\_action] table. |\n| targetRecord | String or GlideRecord | Sys\\_id or GlideRecord of the configured Target table. |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates the target record's applicability for the Remedial Action. * true: the Remedial Action is applicable to the specified target record. * false: the Remedial Action is not applicable to the specified target record. |\n\n### Example\n\nThe following example shows how to check applicability of any Remedial Action against a target record.\n\n```None\nvar remedialAction = \"9ef9924c436521101a24ff53e9b8f2d2\"; //Sys_id of the Remedial Action Execution record \nvar targetRecord = \"df3799a387a921100295ebd73cbb35c4\"; //Sys_id of the Target Record \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar isApplicable = remedialActionEngine.isApplicable(remedialAction, targetRecord); \ngs.info(\"Is applicable: \" + isApplicable);\n```\n\nOutput:\n\n```None\nIs applicable: true\n```\n\n## RemedialActionEngine - isAuthorized(string remedialAction)\n\nChecks if the user is authorized to execute the Remedial Action.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| remedialAction | String or GlideRecord | Sys\\_id or internal\\_name or GlideRecord of the Remedial Action [sn\\_reacf\\_remedial\\_action] table. |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates the resulting success status of the user's authorization. * true: The user's authorization is successful. * false: The user's authorization is unsuccessful. |\n\n### Example\n\nThe following example shows how to check authorization to execute any Remedial Action.\n\n```None\nvar actionSysId = \"e62f550843e121101a24ff53e9b8f23b\"; //Sys_id of the Action \n \nvar remedialActionEngine = new sn_reacf.RemedialActionEngine(); \nvar isAuthorized = remedialActionEngine.isAuthorized(actionSysId); \ngs.info(\"Is user authorized: \" + isAuthorized);\n```\n\nOutput:\n\n```None\nIs user authorized: true\n```\n"}}},{"rowIdx":1998,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RenderProperties - Global"},"description":{"kind":"string","value":"The RenderProperties API provides methods about the current page and is available in Jelly scripts and in UI-action conditions and scripts."},"keywords":{"kind":"list like","value":["RenderProperites","RenderProperties","getEncodedQuery()","getListControl()","getParameterValue(String parameterName)","getReferringURL()","getViewID()","getViewName()","getWindowProperties()","isInDevStudio()","isInteractive()","isManyToMany()","isRelatedList()"],"string":"[\n \"RenderProperites\",\n \"RenderProperties\",\n \"getEncodedQuery()\",\n \"getListControl()\",\n \"getParameterValue(String parameterName)\",\n \"getReferringURL()\",\n \"getViewID()\",\n \"getViewName()\",\n \"getWindowProperties()\",\n \"isInDevStudio()\",\n \"isInteractive()\",\n \"isManyToMany()\",\n \"isRelatedList()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_RenderProperties-API\"><article class=\"nested0\" aria-labelledby=\"title_RenderProperties-API\" id=\"RenderProperties-API\">\n <h1 class=\"title topictitle1\" id=\"title_RenderProperties-API\">RenderProperties <span class=\"ph\">- Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RenderProperties</span> API provides methods about the current page and\n is available in Jelly scripts and in UI-action conditions and scripts.</p>\n <p class=\"p\">Access <span class=\"keyword apiname\">RenderProperties</span> methods using the static variable\n <code class=\"ph codeph\">RP</code>.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-getEncodedQuery\" id=\"RP-getEncodedQuery\">\n <h2 class=\"title topictitle2\" id=\"title_RP-getEncodedQuery\">RenderProperties - getEncodedQuery()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the encoded query from the URL sent to the page.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-getEncodedQuery__table_ksz_5ft_3y\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-getEncodedQuery__table_lsz_5ft_3y\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__2\">Returns the encoded query from the URL sent to the form.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-getEncodedQuery__id_nvn_zpf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for UI action named listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">RP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-getListControl\" id=\"RP-getListControl\">\n <h2 class=\"title topictitle2\" id=\"title_RP-getListControl\">RenderProperties - getListControl()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the list control object for the page.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-getListControl__table_lpg_mgt_3y\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getListControl__table_lpg_mgt_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getListControl__table_lpg_mgt_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getListControl__table_lpg_mgt_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getListControl__table_lpg_mgt_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getListControl__table_lpg_mgt_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getListControl__table_lpg_mgt_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-getListControl__table_mpg_mgt_3y\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getListControl__table_mpg_mgt_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getListControl__table_mpg_mgt_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getListControl__table_mpg_mgt_3y__entry__1\">SysListControl object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getListControl__table_mpg_mgt_3y__entry__2\">The list control object for the page.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-getListControl__id_unr_gqf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-getParameterValue_S\" id=\"RP-getParameterValue_S\">\n <h2 class=\"title topictitle2\" id=\"title_RP-getParameterValue_S\">RenderProperties - getParameterValue(String parameterName)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the value of the specified URL parameter.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-getParameterValue_S__table_p5t_zgt_3y\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__1\">parameterName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__3\">Name of the parameter passed on the URL.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-getParameterValue_S__table_q5t_zgt_3y\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__2\">The parameter's value.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-getParameterValue_S__id_c54_dwf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue("sysparm_changeset"))</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-getReferringURL\" id=\"RP-getReferringURL\">\n <h2 class=\"title topictitle2\" id=\"title_RP-getReferringURL\">RenderProperties - getReferringURL()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the URL where the request originated.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-getReferringURL__table_lrn_5rt_3y\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getReferringURL__table_lrn_5rt_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getReferringURL__table_lrn_5rt_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getReferringURL__table_lrn_5rt_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getReferringURL__table_lrn_5rt_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getReferringURL__table_lrn_5rt_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getReferringURL__table_lrn_5rt_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-getReferringURL__table_mrn_5rt_3y\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getReferringURL__table_mrn_5rt_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getReferringURL__table_mrn_5rt_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getReferringURL__table_mrn_5rt_3y__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getReferringURL__table_mrn_5rt_3y__entry__2\">The URL of the page where the request originated.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-getReferringURL__id_itg_lwf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">RP.getReferringURL().indexOf("sys_import_set.do") == -1 && new global.ImportSetRowHelper().canReadImportSets();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-getViewID\" id=\"RP-getViewID\">\n <h2 class=\"title topictitle2\" id=\"title_RP-getViewID\">RenderProperties - getViewID()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the view the page is using.</p>\n <section class=\"section\">\n <p class=\"p\">This method is not available in scoped applications.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-getViewID__table_z4c_lw2_zx\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewID__table_z4c_lw2_zx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewID__table_z4c_lw2_zx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewID__table_z4c_lw2_zx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewID__table_z4c_lw2_zx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewID__table_z4c_lw2_zx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewID__table_z4c_lw2_zx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-getViewID__table_apc_lw2_zx\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewID__table_apc_lw2_zx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewID__table_apc_lw2_zx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewID__table_apc_lw2_zx__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewID__table_apc_lw2_zx__entry__2\">The sys_id of the view being used.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-getViewName\" id=\"RP-getViewName\">\n <h2 class=\"title topictitle2\" id=\"title_RP-getViewName\">RenderProperties - getViewName()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the name of the view in use.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-getViewName__table_mxv_fst_3y\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewName__table_mxv_fst_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewName__table_mxv_fst_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewName__table_mxv_fst_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewName__table_mxv_fst_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewName__table_mxv_fst_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewName__table_mxv_fst_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-getViewName__table_nxv_fst_3y\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewName__table_nxv_fst_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getViewName__table_nxv_fst_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewName__table_nxv_fst_3y__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getViewName__table_nxv_fst_3y__entry__2\">Name of the view being used.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-getViewName__id_fxt_2xf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">RP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-getWindowProperties\" id=\"RP-getWindowProperties\">\n <h2 class=\"title topictitle2\" id=\"title_RP-getWindowProperties\">RenderProperties - getWindowProperties()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the window's properties.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-getWindowProperties__table_cvh_pst_3y\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getWindowProperties__table_cvh_pst_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getWindowProperties__table_cvh_pst_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getWindowProperties__table_cvh_pst_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getWindowProperties__table_cvh_pst_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getWindowProperties__table_cvh_pst_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getWindowProperties__table_cvh_pst_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-getWindowProperties__table_dvh_pst_3y\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getWindowProperties__table_dvh_pst_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-getWindowProperties__table_dvh_pst_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getWindowProperties__table_dvh_pst_3y__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-getWindowProperties__table_dvh_pst_3y__entry__2\">The window's properties</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-isInDevStudio\" id=\"RP-isInDevStudio\">\n <h2 class=\"title topictitle2\" id=\"title_RP-isInDevStudio\">RenderProperties - isInDevStudio()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true if the page is part of Studio.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-isInDevStudio__table_sxk_zst_3y\"><caption><span class=\"table--title-label\">Table 15. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInDevStudio__table_sxk_zst_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInDevStudio__table_sxk_zst_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInDevStudio__table_sxk_zst_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInDevStudio__table_sxk_zst_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInDevStudio__table_sxk_zst_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInDevStudio__table_sxk_zst_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-isInDevStudio__table_txk_zst_3y\"><caption><span class=\"table--title-label\">Table 16. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInDevStudio__table_txk_zst_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInDevStudio__table_txk_zst_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInDevStudio__table_txk_zst_3y__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInDevStudio__table_txk_zst_3y__entry__2\">Returns true if the page is part of Studio.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-isInDevStudio__id_jyd_fyf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-isInteractive\" id=\"RP-isInteractive\">\n <h2 class=\"title topictitle2\" id=\"title_RP-isInteractive\">RenderProperties - isInteractive()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true if this is an interactive session. An interactive session is when a user\n has logged in as opposed to a REST request.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-isInteractive__table_hvc_ktt_3y\"><caption><span class=\"table--title-label\">Table 17. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInteractive__table_hvc_ktt_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInteractive__table_hvc_ktt_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInteractive__table_hvc_ktt_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInteractive__table_hvc_ktt_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInteractive__table_hvc_ktt_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInteractive__table_hvc_ktt_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-isInteractive__table_ivc_ktt_3y\"><caption><span class=\"table--title-label\">Table 18. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInteractive__table_ivc_ktt_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isInteractive__table_ivc_ktt_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInteractive__table_ivc_ktt_3y__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isInteractive__table_ivc_ktt_3y__entry__2\">True if this is an interactive session.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-isManyToMany\" id=\"RP-isManyToMany\">\n <h2 class=\"title topictitle2\" id=\"title_RP-isManyToMany\">RenderProperties - isManyToMany()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true when the <code class=\"ph codeph\">sysparm_collection_related_file</code> URL parameter is\n set.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-isManyToMany__table_lnf_ztt_3y\"><caption><span class=\"table--title-label\">Table 19. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isManyToMany__table_lnf_ztt_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isManyToMany__table_lnf_ztt_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isManyToMany__table_lnf_ztt_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isManyToMany__table_lnf_ztt_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isManyToMany__table_lnf_ztt_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isManyToMany__table_lnf_ztt_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-isManyToMany__table_mnf_ztt_3y\"><caption><span class=\"table--title-label\">Table 20. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isManyToMany__table_mnf_ztt_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isManyToMany__table_mnf_ztt_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isManyToMany__table_mnf_ztt_3y__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isManyToMany__table_mnf_ztt_3y__entry__2\">Returns true when the <code class=\"ph codeph\">sysparm_collection_related_file</code> URL\n parameter is set.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-isManyToMany__id_xtl_zxf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_RP-isRelatedList\" id=\"RP-isRelatedList\">\n <h2 class=\"title topictitle2\" id=\"title_RP-isRelatedList\">RenderProperties - isRelatedList()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true when the <code class=\"ph codeph\">sys_is_related_list</code> URL-parameter is true.\n Returns false if the parameter is not present.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"RP-isRelatedList__table_cj5_35t_3y\"><caption><span class=\"table--title-label\">Table 21. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isRelatedList__table_cj5_35t_3y__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isRelatedList__table_cj5_35t_3y__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isRelatedList__table_cj5_35t_3y__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isRelatedList__table_cj5_35t_3y__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isRelatedList__table_cj5_35t_3y__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isRelatedList__table_cj5_35t_3y__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"RP-isRelatedList__table_dj5_35t_3y\"><caption><span class=\"table--title-label\">Table 22. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isRelatedList__table_dj5_35t_3y__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"RP-isRelatedList__table_dj5_35t_3y__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isRelatedList__table_dj5_35t_3y__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"RP-isRelatedList__table_dj5_35t_3y__entry__2\">True if the URL parameter <code class=\"ph codeph\">sys_is_related_list</code> is true.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"RP-isRelatedList__id_mq5_sxf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for a UI action listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && RP.isRelatedList()</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RenderProperties - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206693\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206693\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"RenderProperties-API\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"RenderProperites,RenderProperties,getEncodedQuery(),getListControl(),getParameterValue(String parameterName),getReferringURL(),getViewID(),getViewName(),getWindowProperties(),isInDevStudio(),isInteractive(),isManyToMany(),isRelatedList()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RenderProperties API provides methods about the current page and is available in Jelly scripts and in UI-action conditions and scripts.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"RenderProperites, RenderProperties, getEncodedQuery(), getListControl(), getParameterValue(String parameterName), getReferringURL(), getViewID(), getViewName(), getWindowProperties(), isInDevStudio(), isInteractive(), isManyToMany(), isRelatedList()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\",\n \"page_key\": 41206693,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 4723,\n \"img_count\": 0,\n \"read_time\": 3,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 629\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RenderProperties - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_RenderProperties-API\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_RenderProperties-API\\\" id=\\\"RenderProperties-API\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_RenderProperties-API\\\">RenderProperties <span class=\\\"ph\\\">- Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RenderProperties</span> API provides methods about the current page and\\n is available in Jelly scripts and in UI-action conditions and scripts.</p>\\n <p class=\\\"p\\\">Access <span class=\\\"keyword apiname\\\">RenderProperties</span> methods using the static variable\\n <code class=\\\"ph codeph\\\">RP</code>.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-getEncodedQuery\\\" id=\\\"RP-getEncodedQuery\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-getEncodedQuery\\\">RenderProperties - getEncodedQuery()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the encoded query from the URL sent to the page.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-getEncodedQuery__table_ksz_5ft_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getEncodedQuery__table_ksz_5ft_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-getEncodedQuery__table_lsz_5ft_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getEncodedQuery__table_lsz_5ft_3y__entry__2\\\">Returns the encoded query from the URL sent to the form.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-getEncodedQuery__id_nvn_zpf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for UI action named listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">RP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-getListControl\\\" id=\\\"RP-getListControl\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-getListControl\\\">RenderProperties - getListControl()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the list control object for the page.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-getListControl__table_lpg_mgt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getListControl__table_lpg_mgt_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getListControl__table_lpg_mgt_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getListControl__table_lpg_mgt_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getListControl__table_lpg_mgt_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getListControl__table_lpg_mgt_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getListControl__table_lpg_mgt_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-getListControl__table_mpg_mgt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getListControl__table_mpg_mgt_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getListControl__table_mpg_mgt_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getListControl__table_mpg_mgt_3y__entry__1\\\">SysListControl object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getListControl__table_mpg_mgt_3y__entry__2\\\">The list control object for the page.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-getListControl__id_unr_gqf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-getParameterValue_S\\\" id=\\\"RP-getParameterValue_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-getParameterValue_S\\\">RenderProperties - getParameterValue(String parameterName)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the value of the specified URL parameter.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-getParameterValue_S__table_p5t_zgt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__1\\\">parameterName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getParameterValue_S__table_p5t_zgt_3y__entry__3\\\">Name of the parameter passed on the URL.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-getParameterValue_S__table_q5t_zgt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getParameterValue_S__table_q5t_zgt_3y__entry__2\\\">The parameter's value.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-getParameterValue_S__id_c54_dwf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue("sysparm_changeset"))</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-getReferringURL\\\" id=\\\"RP-getReferringURL\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-getReferringURL\\\">RenderProperties - getReferringURL()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the URL where the request originated.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-getReferringURL__table_lrn_5rt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getReferringURL__table_lrn_5rt_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getReferringURL__table_lrn_5rt_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getReferringURL__table_lrn_5rt_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getReferringURL__table_lrn_5rt_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getReferringURL__table_lrn_5rt_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getReferringURL__table_lrn_5rt_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-getReferringURL__table_mrn_5rt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getReferringURL__table_mrn_5rt_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getReferringURL__table_mrn_5rt_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getReferringURL__table_mrn_5rt_3y__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getReferringURL__table_mrn_5rt_3y__entry__2\\\">The URL of the page where the request originated.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-getReferringURL__id_itg_lwf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">RP.getReferringURL().indexOf("sys_import_set.do") == -1 && new global.ImportSetRowHelper().canReadImportSets();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-getViewID\\\" id=\\\"RP-getViewID\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-getViewID\\\">RenderProperties - getViewID()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the view the page is using.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">This method is not available in scoped applications.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-getViewID__table_z4c_lw2_zx\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewID__table_z4c_lw2_zx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewID__table_z4c_lw2_zx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewID__table_z4c_lw2_zx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewID__table_z4c_lw2_zx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewID__table_z4c_lw2_zx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewID__table_z4c_lw2_zx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-getViewID__table_apc_lw2_zx\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewID__table_apc_lw2_zx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewID__table_apc_lw2_zx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewID__table_apc_lw2_zx__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewID__table_apc_lw2_zx__entry__2\\\">The sys_id of the view being used.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-getViewName\\\" id=\\\"RP-getViewName\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-getViewName\\\">RenderProperties - getViewName()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the name of the view in use.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-getViewName__table_mxv_fst_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewName__table_mxv_fst_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewName__table_mxv_fst_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewName__table_mxv_fst_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewName__table_mxv_fst_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewName__table_mxv_fst_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewName__table_mxv_fst_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-getViewName__table_nxv_fst_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewName__table_nxv_fst_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getViewName__table_nxv_fst_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewName__table_nxv_fst_3y__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getViewName__table_nxv_fst_3y__entry__2\\\">Name of the view being used.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-getViewName__id_fxt_2xf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">RP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-getWindowProperties\\\" id=\\\"RP-getWindowProperties\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-getWindowProperties\\\">RenderProperties - getWindowProperties()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the window's properties.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-getWindowProperties__table_cvh_pst_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getWindowProperties__table_cvh_pst_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getWindowProperties__table_cvh_pst_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getWindowProperties__table_cvh_pst_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getWindowProperties__table_cvh_pst_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getWindowProperties__table_cvh_pst_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getWindowProperties__table_cvh_pst_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-getWindowProperties__table_dvh_pst_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getWindowProperties__table_dvh_pst_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-getWindowProperties__table_dvh_pst_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getWindowProperties__table_dvh_pst_3y__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-getWindowProperties__table_dvh_pst_3y__entry__2\\\">The window's properties</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-isInDevStudio\\\" id=\\\"RP-isInDevStudio\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-isInDevStudio\\\">RenderProperties - isInDevStudio()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true if the page is part of Studio.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-isInDevStudio__table_sxk_zst_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInDevStudio__table_sxk_zst_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInDevStudio__table_sxk_zst_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInDevStudio__table_sxk_zst_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInDevStudio__table_sxk_zst_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInDevStudio__table_sxk_zst_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInDevStudio__table_sxk_zst_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-isInDevStudio__table_txk_zst_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInDevStudio__table_txk_zst_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInDevStudio__table_txk_zst_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInDevStudio__table_txk_zst_3y__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInDevStudio__table_txk_zst_3y__entry__2\\\">Returns true if the page is part of Studio.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-isInDevStudio__id_jyd_fyf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-isInteractive\\\" id=\\\"RP-isInteractive\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-isInteractive\\\">RenderProperties - isInteractive()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true if this is an interactive session. An interactive session is when a user\\n has logged in as opposed to a REST request.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-isInteractive__table_hvc_ktt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInteractive__table_hvc_ktt_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInteractive__table_hvc_ktt_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInteractive__table_hvc_ktt_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInteractive__table_hvc_ktt_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInteractive__table_hvc_ktt_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInteractive__table_hvc_ktt_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-isInteractive__table_ivc_ktt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInteractive__table_ivc_ktt_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isInteractive__table_ivc_ktt_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInteractive__table_ivc_ktt_3y__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isInteractive__table_ivc_ktt_3y__entry__2\\\">True if this is an interactive session.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-isManyToMany\\\" id=\\\"RP-isManyToMany\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-isManyToMany\\\">RenderProperties - isManyToMany()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true when the <code class=\\\"ph codeph\\\">sysparm_collection_related_file</code> URL parameter is\\n set.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-isManyToMany__table_lnf_ztt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 19. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isManyToMany__table_lnf_ztt_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isManyToMany__table_lnf_ztt_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isManyToMany__table_lnf_ztt_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isManyToMany__table_lnf_ztt_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isManyToMany__table_lnf_ztt_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isManyToMany__table_lnf_ztt_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-isManyToMany__table_mnf_ztt_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 20. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isManyToMany__table_mnf_ztt_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isManyToMany__table_mnf_ztt_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isManyToMany__table_mnf_ztt_3y__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isManyToMany__table_mnf_ztt_3y__entry__2\\\">Returns true when the <code class=\\\"ph codeph\\\">sysparm_collection_related_file</code> URL\\n parameter is set.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-isManyToMany__id_xtl_zxf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_RP-isRelatedList\\\" id=\\\"RP-isRelatedList\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_RP-isRelatedList\\\">RenderProperties - isRelatedList()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true when the <code class=\\\"ph codeph\\\">sys_is_related_list</code> URL-parameter is true.\\n Returns false if the parameter is not present.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"RP-isRelatedList__table_cj5_35t_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 21. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isRelatedList__table_cj5_35t_3y__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isRelatedList__table_cj5_35t_3y__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isRelatedList__table_cj5_35t_3y__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isRelatedList__table_cj5_35t_3y__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isRelatedList__table_cj5_35t_3y__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isRelatedList__table_cj5_35t_3y__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"RP-isRelatedList__table_dj5_35t_3y\\\"><caption><span class=\\\"table--title-label\\\">Table 22. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isRelatedList__table_dj5_35t_3y__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"RP-isRelatedList__table_dj5_35t_3y__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isRelatedList__table_dj5_35t_3y__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"RP-isRelatedList__table_dj5_35t_3y__entry__2\\\">True if the URL parameter <code class=\\\"ph codeph\\\">sys_is_related_list</code> is true.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"RP-isRelatedList__id_mq5_sxf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for a UI action listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderProperties/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && RP.isRelatedList()</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RenderProperties - Global\n\nThe RenderProperties API provides methods about the current page and\nis available in Jelly scripts and in UI-action conditions and scripts.\n\nAccess RenderProperties methods using the static variable\n`RP`.\n\n## RenderProperties - getEncodedQuery()\n\nReturns the encoded query from the URL sent to the page.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Returns the encoded query from the URL sent to the form. |\n\n### Example\n\nThe following example is used in a condition for UI action named listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)\n```\n\n## RenderProperties - getListControl()\n\nReturns the list control object for the page.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| SysListControl object | The list control object for the page. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## RenderProperties - getParameterValue(String parameterName)\n\nReturns the value of the specified URL parameter.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| parameterName | String | Name of the parameter passed on the URL. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | The parameter's value. |\n\n### Example\n\nThe following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue(\"sysparm_changeset\"))\n```\n\n## RenderProperties - getReferringURL()\n\nReturns the URL where the request originated.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| String | The URL of the page where the request originated. |\n\n### Example\n\nThe following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getReferringURL().indexOf(\"sys_import_set.do\") == -1 && new global.ImportSetRowHelper().canReadImportSets();\n```\n\n## RenderProperties - getViewID()\n\nReturns the view the page is using.\n\nThis method is not available in scoped applications.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | The sys\\_id of the view being used. |\n\n## RenderProperties - getViewName()\n\nReturns the name of the view in use.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the view being used. |\n\n### Example\n\nThe following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined\n```\n\n## RenderProperties - getWindowProperties()\n\nReturns the window's properties.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | The window's properties |\n\n## RenderProperties - isInDevStudio()\n\nReturns true if the page is part of Studio.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true if the page is part of Studio. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## RenderProperties - isInteractive()\n\nReturns true if this is an interactive session. An interactive session is when a user\nhas logged in as opposed to a REST request.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if this is an interactive session. |\n\n## RenderProperties - isManyToMany()\n\nReturns true when the `sysparm_collection_related_file` URL parameter is\nset.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true when the `sysparm_collection_related_file` URL parameter is set. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## RenderProperties - isRelatedList()\n\nReturns true when the `sys_is_related_list` URL-parameter is true.\nReturns false if the parameter is not present.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if the URL parameter `sys_is_related_list` is true. |\n\n### Example\n\nThe following example is used in a condition for a UI action listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && RP.isRelatedList()\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RenderProperties - Global\ndescription: The RenderProperties API provides methods about the current page and\n is available in Jelly scripts and in UI-action conditions and scripts.\nkeywords:\n- RenderProperites\n- RenderProperties\n- getEncodedQuery()\n- getListControl()\n- getParameterValue(String parameterName)\n- getReferringURL()\n- getViewID()\n- getViewName()\n- getWindowProperties()\n- isInDevStudio()\n- isInteractive()\n- isManyToMany()\n- isRelatedList()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RenderProperties - Global\n\nThe RenderProperties API provides methods about the current page and\nis available in Jelly scripts and in UI-action conditions and scripts.\n\nAccess RenderProperties methods using the static variable\n`RP`.\n\n## RenderProperties - getEncodedQuery()\n\nReturns the encoded query from the URL sent to the page.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Returns the encoded query from the URL sent to the form. |\n\n### Example\n\nThe following example is used in a condition for UI action named listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)\n```\n\n## RenderProperties - getListControl()\n\nReturns the list control object for the page.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| SysListControl object | The list control object for the page. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## RenderProperties - getParameterValue(String parameterName)\n\nReturns the value of the specified URL parameter.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| parameterName | String | Name of the parameter passed on the URL. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | The parameter's value. |\n\n### Example\n\nThe following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue(\"sysparm_changeset\"))\n```\n\n## RenderProperties - getReferringURL()\n\nReturns the URL where the request originated.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| String | The URL of the page where the request originated. |\n\n### Example\n\nThe following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getReferringURL().indexOf(\"sys_import_set.do\") == -1 && new global.ImportSetRowHelper().canReadImportSets();\n```\n\n## RenderProperties - getViewID()\n\nReturns the view the page is using.\n\nThis method is not available in scoped applications.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | The sys\\_id of the view being used. |\n\n## RenderProperties - getViewName()\n\nReturns the name of the view in use.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the view being used. |\n\n### Example\n\nThe following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined\n```\n\n## RenderProperties - getWindowProperties()\n\nReturns the window's properties.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | The window's properties |\n\n## RenderProperties - isInDevStudio()\n\nReturns true if the page is part of Studio.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true if the page is part of Studio. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## RenderProperties - isInteractive()\n\nReturns true if this is an interactive session. An interactive session is when a user\nhas logged in as opposed to a REST request.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if this is an interactive session. |\n\n## RenderProperties - isManyToMany()\n\nReturns true when the `sysparm_collection_related_file` URL parameter is\nset.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true when the `sysparm_collection_related_file` URL parameter is set. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## RenderProperties - isRelatedList()\n\nReturns true when the `sys_is_related_list` URL-parameter is true.\nReturns false if the parameter is not present.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if the URL parameter `sys_is_related_list` is true. |\n\n### Example\n\nThe following example is used in a condition for a UI action listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && RP.isRelatedList()\n```\n"}}},{"rowIdx":1999,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"4.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"RenderProperties - Scoped"},"description":{"kind":"string","value":"The RenderProperties API provides methods about the current page and is available in Jelly scripts and in UI-action conditions and scripts."},"keywords":{"kind":"list like","value":["Scoped RenderProperties","Scoped ScopedRenderProperties","getEncodedQuery()","getListControl()","getParameterValue(String parameterName)","getReferringURL()","getViewName()","getWindowProperties()","isInDevStudio()","isInteractive()","isManyToMany()","isRelatedList()"],"string":"[\n \"Scoped RenderProperties\",\n \"Scoped ScopedRenderProperties\",\n \"getEncodedQuery()\",\n \"getListControl()\",\n \"getParameterValue(String parameterName)\",\n \"getReferringURL()\",\n \"getViewName()\",\n \"getWindowProperties()\",\n \"isInDevStudio()\",\n \"isInteractive()\",\n \"isManyToMany()\",\n \"isRelatedList()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_RenderProperties-Scoped-API\"><article class=\"nested0\" aria-labelledby=\"title_RenderProperties-Scoped-API\" id=\"RenderProperties-Scoped-API\">\n <h1 class=\"title topictitle1\" id=\"title_RenderProperties-Scoped-API\">RenderProperties <span class=\"ph\">- Scoped</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">RenderProperties</span> API provides methods about the current page and\n is available in Jelly scripts and in UI-action conditions and scripts.</p>\n <p class=\"p\">Access <span class=\"keyword apiname\">RenderProperties</span> methods using the static variable\n <code class=\"ph codeph\">RP</code>.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-getEncodedQuery\" id=\"SRP-getEncodedQuery\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-getEncodedQuery\">Scoped ScopedRenderProperties - getEncodedQuery()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the encoded query from the URL sent to the page.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-getEncodedQuery__table_p1p_sqz_yx\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-getEncodedQuery__table_q1p_sqz_yx\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__2\">Returns the encoded query from the URL sent to the form.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-getEncodedQuery__id_un3_cqf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for UI action named listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">RP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-getListControl\" id=\"SRP-getListControl\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-getListControl\">Scoped ScopedRenderProperties - getListControl()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the list control object for the page.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-getListControl__table_qvp_n5z_yx\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getListControl__table_qvp_n5z_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getListControl__table_qvp_n5z_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getListControl__table_qvp_n5z_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getListControl__table_qvp_n5z_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getListControl__table_qvp_n5z_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getListControl__table_qvp_n5z_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-getListControl__table_rvp_n5z_yx\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getListControl__table_rvp_n5z_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getListControl__table_rvp_n5z_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getListControl__table_rvp_n5z_yx__entry__1\">ScopedSysListControl object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getListControl__table_rvp_n5z_yx__entry__2\">The list control object for the page.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-getListControl__id_h2q_hqf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-getParameterValue_S\" id=\"SRP-getParameterValue_S\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-getParameterValue_S\">Scoped ScopedRenderProperties - getParameterValue(String parameterName)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the value of the specified URL parameter.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-getParameterValue_S__table_b2w_zgz_yx\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__1\">parameterName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__3\">Name of the parameter passed on the URL.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-getParameterValue_S__table_c2w_zgz_yx\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__2\">The parameter's value.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-getParameterValue_S__id_lr3_2wf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue("sysparm_changeset"))</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-getReferringURL\" id=\"SRP-getReferringURL\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-getReferringURL\">Scoped ScopedRenderProperties - getReferringURL()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the URL where the request originated.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-getReferringURL__table_vgr_dsz_yx\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getReferringURL__table_vgr_dsz_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getReferringURL__table_vgr_dsz_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getReferringURL__table_vgr_dsz_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getReferringURL__table_vgr_dsz_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getReferringURL__table_vgr_dsz_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getReferringURL__table_vgr_dsz_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-getReferringURL__table_wgr_dsz_yx\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getReferringURL__table_wgr_dsz_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getReferringURL__table_wgr_dsz_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getReferringURL__table_wgr_dsz_yx__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getReferringURL__table_wgr_dsz_yx__entry__2\">The URL of the page where the request originated.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-getReferringURL__id_ur5_lwf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">RP.getReferringURL().indexOf("sys_import_set.do") == -1 && new global.ImportSetRowHelper().canReadImportSets();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-getViewName\" id=\"SRP-getViewName\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-getViewName\">Scoped ScopedRenderProperties - getViewName()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the name of the view in use.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-getViewName__table_kd3_15z_yx\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getViewName__table_kd3_15z_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getViewName__table_kd3_15z_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getViewName__table_kd3_15z_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getViewName__table_kd3_15z_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getViewName__table_kd3_15z_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getViewName__table_kd3_15z_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-getViewName__table_ld3_15z_yx\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getViewName__table_ld3_15z_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getViewName__table_ld3_15z_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getViewName__table_ld3_15z_yx__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getViewName__table_ld3_15z_yx__entry__2\">Name of the view being used.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-getViewName__id_ozb_nxf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">RP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-getWindowProperties\" id=\"SRP-getWindowProperties\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-getWindowProperties\">Scoped ScopedRenderProperties - getWindowProperties()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the window's properties.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-getWindowProperties__table_fw2_kxz_yx\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-getWindowProperties__table_gw2_kxz_yx\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__2\">The window's properties</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-isInDevStudio\" id=\"SRP-isInDevStudio\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-isInDevStudio\">Scoped ScopedRenderProperties - isInDevStudio()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true if the page is part of Studio.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-isInDevStudio__table_ocv_yxz_yx\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-isInDevStudio__table_pcv_yxz_yx\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__2\">Returns true if the page is part of Studio.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-isInDevStudio__id_tqc_yxf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-isInteractive\" id=\"SRP-isInteractive\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-isInteractive\">Scoped ScopedRenderProperties - isInteractive()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true if this is an interactive session. An interactive session is when a user\n has logged in as opposed to a REST request.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-isInteractive__table_gwd_2tz_yx\"><caption><span class=\"table--title-label\">Table 15. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInteractive__table_gwd_2tz_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInteractive__table_gwd_2tz_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInteractive__table_gwd_2tz_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInteractive__table_gwd_2tz_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInteractive__table_gwd_2tz_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInteractive__table_gwd_2tz_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-isInteractive__table_hwd_2tz_yx\"><caption><span class=\"table--title-label\">Table 16. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInteractive__table_hwd_2tz_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isInteractive__table_hwd_2tz_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInteractive__table_hwd_2tz_yx__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isInteractive__table_hwd_2tz_yx__entry__2\">True if this is an interactive session.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-isManyToMany\" id=\"SRP-isManyToMany\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-isManyToMany\">Scoped ScopedRenderProperties - isManyToMany()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true when the <code class=\"ph codeph\">sysparm_collection_related_file</code> URL parameter is\n set.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-isManyToMany__table_t2z_g4z_yx\"><caption><span class=\"table--title-label\">Table 17. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isManyToMany__table_t2z_g4z_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isManyToMany__table_t2z_g4z_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isManyToMany__table_t2z_g4z_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isManyToMany__table_t2z_g4z_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isManyToMany__table_t2z_g4z_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isManyToMany__table_t2z_g4z_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-isManyToMany__table_u2z_g4z_yx\"><caption><span class=\"table--title-label\">Table 18. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isManyToMany__table_u2z_g4z_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isManyToMany__table_u2z_g4z_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isManyToMany__table_u2z_g4z_yx__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isManyToMany__table_u2z_g4z_yx__entry__2\">Returns true when the <code class=\"ph codeph\">sysparm_collection_related_file</code> URL\n parameter is set.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-isManyToMany__id_sf4_dyf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SRP-isRelatedList\" id=\"SRP-isRelatedList\">\n <h2 class=\"title topictitle2\" id=\"title_SRP-isRelatedList\">Scoped ScopedRenderProperties - isRelatedList()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns true when the <code class=\"ph codeph\">sys_is_related_list</code> URL-parameter is true.\n Returns false if the parameter is not present.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SRP-isRelatedList__table_wwh_xlz_yx\"><caption><span class=\"table--title-label\">Table 19. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isRelatedList__table_wwh_xlz_yx__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isRelatedList__table_wwh_xlz_yx__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isRelatedList__table_wwh_xlz_yx__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isRelatedList__table_wwh_xlz_yx__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isRelatedList__table_wwh_xlz_yx__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isRelatedList__table_wwh_xlz_yx__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SRP-isRelatedList__table_xwh_xlz_yx\"><caption><span class=\"table--title-label\">Table 20. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isRelatedList__table_xwh_xlz_yx__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SRP-isRelatedList__table_xwh_xlz_yx__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isRelatedList__table_xwh_xlz_yx__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SRP-isRelatedList__table_xwh_xlz_yx__entry__2\">True if the URL parameter <code class=\"ph codeph\">sys_is_related_list</code> is true.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"SRP-isRelatedList__id_d5q_txf_3yb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n \n <p class=\"p\">The following example is used in a condition for a UI action listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\" class=\"xref\">UI actions</a>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">current.canCreate() && RP.isRelatedList()</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">RenderProperties - Scoped</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41206698\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41206698\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"RenderProperties-Scoped-API\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"Scoped RenderProperties,Scoped ScopedRenderProperties,getEncodedQuery(),getListControl(),getParameterValue(String parameterName),getReferringURL(),getViewName(),getWindowProperties(),isInDevStudio(),isInteractive(),isManyToMany(),isRelatedList()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The RenderProperties API provides methods about the current page and is available in Jelly scripts and in UI-action conditions and scripts.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"Scoped RenderProperties, Scoped ScopedRenderProperties, getEncodedQuery(), getListControl(), getParameterValue(String parameterName), getReferringURL(), getViewName(), getWindowProperties(), isInDevStudio(), isInteractive(), isManyToMany(), isRelatedList()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\",\n \"page_key\": 41206698,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 4673,\n \"img_count\": 0,\n \"read_time\": 3,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 610\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"RenderProperties - Scoped\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_RenderProperties-Scoped-API\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_RenderProperties-Scoped-API\\\" id=\\\"RenderProperties-Scoped-API\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_RenderProperties-Scoped-API\\\">RenderProperties <span class=\\\"ph\\\">- Scoped</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">RenderProperties</span> API provides methods about the current page and\\n is available in Jelly scripts and in UI-action conditions and scripts.</p>\\n <p class=\\\"p\\\">Access <span class=\\\"keyword apiname\\\">RenderProperties</span> methods using the static variable\\n <code class=\\\"ph codeph\\\">RP</code>.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-getEncodedQuery\\\" id=\\\"SRP-getEncodedQuery\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-getEncodedQuery\\\">Scoped ScopedRenderProperties - getEncodedQuery()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the encoded query from the URL sent to the page.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-getEncodedQuery__table_p1p_sqz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getEncodedQuery__table_p1p_sqz_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-getEncodedQuery__table_q1p_sqz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getEncodedQuery__table_q1p_sqz_yx__entry__2\\\">Returns the encoded query from the URL sent to the form.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-getEncodedQuery__id_un3_cqf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for UI action named listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">RP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-getListControl\\\" id=\\\"SRP-getListControl\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-getListControl\\\">Scoped ScopedRenderProperties - getListControl()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the list control object for the page.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-getListControl__table_qvp_n5z_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getListControl__table_qvp_n5z_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getListControl__table_qvp_n5z_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getListControl__table_qvp_n5z_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getListControl__table_qvp_n5z_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getListControl__table_qvp_n5z_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getListControl__table_qvp_n5z_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-getListControl__table_rvp_n5z_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getListControl__table_rvp_n5z_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getListControl__table_rvp_n5z_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getListControl__table_rvp_n5z_yx__entry__1\\\">ScopedSysListControl object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getListControl__table_rvp_n5z_yx__entry__2\\\">The list control object for the page.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-getListControl__id_h2q_hqf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-getParameterValue_S\\\" id=\\\"SRP-getParameterValue_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-getParameterValue_S\\\">Scoped ScopedRenderProperties - getParameterValue(String parameterName)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the value of the specified URL parameter.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-getParameterValue_S__table_b2w_zgz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__1\\\">parameterName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getParameterValue_S__table_b2w_zgz_yx__entry__3\\\">Name of the parameter passed on the URL.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-getParameterValue_S__table_c2w_zgz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getParameterValue_S__table_c2w_zgz_yx__entry__2\\\">The parameter's value.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-getParameterValue_S__id_lr3_2wf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue("sysparm_changeset"))</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-getReferringURL\\\" id=\\\"SRP-getReferringURL\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-getReferringURL\\\">Scoped ScopedRenderProperties - getReferringURL()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the URL where the request originated.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-getReferringURL__table_vgr_dsz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getReferringURL__table_vgr_dsz_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getReferringURL__table_vgr_dsz_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getReferringURL__table_vgr_dsz_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getReferringURL__table_vgr_dsz_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getReferringURL__table_vgr_dsz_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getReferringURL__table_vgr_dsz_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-getReferringURL__table_wgr_dsz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getReferringURL__table_wgr_dsz_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getReferringURL__table_wgr_dsz_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getReferringURL__table_wgr_dsz_yx__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getReferringURL__table_wgr_dsz_yx__entry__2\\\">The URL of the page where the request originated.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-getReferringURL__id_ur5_lwf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">RP.getReferringURL().indexOf("sys_import_set.do") == -1 && new global.ImportSetRowHelper().canReadImportSets();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-getViewName\\\" id=\\\"SRP-getViewName\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-getViewName\\\">Scoped ScopedRenderProperties - getViewName()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the name of the view in use.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-getViewName__table_kd3_15z_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getViewName__table_kd3_15z_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getViewName__table_kd3_15z_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getViewName__table_kd3_15z_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getViewName__table_kd3_15z_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getViewName__table_kd3_15z_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getViewName__table_kd3_15z_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-getViewName__table_ld3_15z_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getViewName__table_ld3_15z_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getViewName__table_ld3_15z_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getViewName__table_ld3_15z_yx__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getViewName__table_ld3_15z_yx__entry__2\\\">Name of the view being used.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-getViewName__id_ozb_nxf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">RP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-getWindowProperties\\\" id=\\\"SRP-getWindowProperties\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-getWindowProperties\\\">Scoped ScopedRenderProperties - getWindowProperties()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the window's properties.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-getWindowProperties__table_fw2_kxz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getWindowProperties__table_fw2_kxz_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-getWindowProperties__table_gw2_kxz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-getWindowProperties__table_gw2_kxz_yx__entry__2\\\">The window's properties</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-isInDevStudio\\\" id=\\\"SRP-isInDevStudio\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-isInDevStudio\\\">Scoped ScopedRenderProperties - isInDevStudio()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true if the page is part of Studio.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-isInDevStudio__table_ocv_yxz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInDevStudio__table_ocv_yxz_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-isInDevStudio__table_pcv_yxz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInDevStudio__table_pcv_yxz_yx__entry__2\\\">Returns true if the page is part of Studio.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-isInDevStudio__id_tqc_yxf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-isInteractive\\\" id=\\\"SRP-isInteractive\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-isInteractive\\\">Scoped ScopedRenderProperties - isInteractive()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true if this is an interactive session. An interactive session is when a user\\n has logged in as opposed to a REST request.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-isInteractive__table_gwd_2tz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInteractive__table_gwd_2tz_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInteractive__table_gwd_2tz_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInteractive__table_gwd_2tz_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInteractive__table_gwd_2tz_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInteractive__table_gwd_2tz_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInteractive__table_gwd_2tz_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-isInteractive__table_hwd_2tz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInteractive__table_hwd_2tz_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isInteractive__table_hwd_2tz_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInteractive__table_hwd_2tz_yx__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isInteractive__table_hwd_2tz_yx__entry__2\\\">True if this is an interactive session.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-isManyToMany\\\" id=\\\"SRP-isManyToMany\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-isManyToMany\\\">Scoped ScopedRenderProperties - isManyToMany()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true when the <code class=\\\"ph codeph\\\">sysparm_collection_related_file</code> URL parameter is\\n set.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-isManyToMany__table_t2z_g4z_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isManyToMany__table_t2z_g4z_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isManyToMany__table_t2z_g4z_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isManyToMany__table_t2z_g4z_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isManyToMany__table_t2z_g4z_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isManyToMany__table_t2z_g4z_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isManyToMany__table_t2z_g4z_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-isManyToMany__table_u2z_g4z_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isManyToMany__table_u2z_g4z_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isManyToMany__table_u2z_g4z_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isManyToMany__table_u2z_g4z_yx__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isManyToMany__table_u2z_g4z_yx__entry__2\\\">Returns true when the <code class=\\\"ph codeph\\\">sysparm_collection_related_file</code> URL\\n parameter is set.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-isManyToMany__id_sf4_dyf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SRP-isRelatedList\\\" id=\\\"SRP-isRelatedList\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SRP-isRelatedList\\\">Scoped ScopedRenderProperties - isRelatedList()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns true when the <code class=\\\"ph codeph\\\">sys_is_related_list</code> URL-parameter is true.\\n Returns false if the parameter is not present.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SRP-isRelatedList__table_wwh_xlz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 19. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isRelatedList__table_wwh_xlz_yx__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isRelatedList__table_wwh_xlz_yx__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isRelatedList__table_wwh_xlz_yx__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isRelatedList__table_wwh_xlz_yx__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isRelatedList__table_wwh_xlz_yx__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isRelatedList__table_wwh_xlz_yx__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SRP-isRelatedList__table_xwh_xlz_yx\\\"><caption><span class=\\\"table--title-label\\\">Table 20. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isRelatedList__table_xwh_xlz_yx__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SRP-isRelatedList__table_xwh_xlz_yx__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isRelatedList__table_xwh_xlz_yx__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SRP-isRelatedList__table_xwh_xlz_yx__entry__2\\\">True if the URL parameter <code class=\\\"ph codeph\\\">sys_is_related_list</code> is true.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"SRP-isRelatedList__id_d5q_txf_3yb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n \\n <p class=\\\"p\\\">The following example is used in a condition for a UI action listed in the UI Actions [sys_ui_action] table. See also <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/RenderPropertiesScoped/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_UIActions&version=vancouver&pubname=vancouver-platform-administration\\\" class=\\\"xref\\\">UI actions</a>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">current.canCreate() && RP.isRelatedList()</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RenderProperties - Scoped\n\nThe RenderProperties API provides methods about the current page and\nis available in Jelly scripts and in UI-action conditions and scripts.\n\nAccess RenderProperties methods using the static variable\n`RP`.\n\n## Scoped ScopedRenderProperties - getEncodedQuery()\n\nReturns the encoded query from the URL sent to the page.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Returns the encoded query from the URL sent to the form. |\n\n### Example\n\nThe following example is used in a condition for UI action named listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)\n```\n\n## Scoped ScopedRenderProperties - getListControl()\n\nReturns the list control object for the page.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| ScopedSysListControl object | The list control object for the page. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped ScopedRenderProperties - getParameterValue(String parameterName)\n\nReturns the value of the specified URL parameter.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| parameterName | String | Name of the parameter passed on the URL. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | The parameter's value. |\n\n### Example\n\nThe following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue(\"sysparm_changeset\"))\n```\n\n## Scoped ScopedRenderProperties - getReferringURL()\n\nReturns the URL where the request originated.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| String | The URL of the page where the request originated. |\n\n### Example\n\nThe following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getReferringURL().indexOf(\"sys_import_set.do\") == -1 && new global.ImportSetRowHelper().canReadImportSets();\n```\n\n## Scoped ScopedRenderProperties - getViewName()\n\nReturns the name of the view in use.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the view being used. |\n\n### Example\n\nThe following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined\n```\n\n## Scoped ScopedRenderProperties - getWindowProperties()\n\nReturns the window's properties.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| Object | The window's properties |\n\n## Scoped ScopedRenderProperties - isInDevStudio()\n\nReturns true if the page is part of Studio.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true if the page is part of Studio. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped ScopedRenderProperties - isInteractive()\n\nReturns true if this is an interactive session. An interactive session is when a user\nhas logged in as opposed to a REST request.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if this is an interactive session. |\n\n## Scoped ScopedRenderProperties - isManyToMany()\n\nReturns true when the `sysparm_collection_related_file` URL parameter is\nset.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true when the `sysparm_collection_related_file` URL parameter is set. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped ScopedRenderProperties - isRelatedList()\n\nReturns true when the `sys_is_related_list` URL-parameter is true.\nReturns false if the parameter is not present.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if the URL parameter `sys_is_related_list` is true. |\n\n### Example\n\nThe following example is used in a condition for a UI action listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && RP.isRelatedList()\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: RenderProperties - Scoped\ndescription: The RenderProperties API provides methods about the current page and\n is available in Jelly scripts and in UI-action conditions and scripts.\nkeywords:\n- Scoped RenderProperties\n- Scoped ScopedRenderProperties\n- getEncodedQuery()\n- getListControl()\n- getParameterValue(String parameterName)\n- getReferringURL()\n- getViewName()\n- getWindowProperties()\n- isInDevStudio()\n- isInteractive()\n- isManyToMany()\n- isRelatedList()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# RenderProperties - Scoped\n\nThe RenderProperties API provides methods about the current page and\nis available in Jelly scripts and in UI-action conditions and scripts.\n\nAccess RenderProperties methods using the static variable\n`RP`.\n\n## Scoped ScopedRenderProperties - getEncodedQuery()\n\nReturns the encoded query from the URL sent to the page.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Returns the encoded query from the URL sent to the form. |\n\n### Example\n\nThe following example is used in a condition for UI action named listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)\n```\n\n## Scoped ScopedRenderProperties - getListControl()\n\nReturns the list control object for the page.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| ScopedSysListControl object | The list control object for the page. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped ScopedRenderProperties - getParameterValue(String parameterName)\n\nReturns the value of the specified URL parameter.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| parameterName | String | Name of the parameter passed on the URL. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | The parameter's value. |\n\n### Example\n\nThe following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue(\"sysparm_changeset\"))\n```\n\n## Scoped ScopedRenderProperties - getReferringURL()\n\nReturns the URL where the request originated.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| String | The URL of the page where the request originated. |\n\n### Example\n\nThe following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getReferringURL().indexOf(\"sys_import_set.do\") == -1 && new global.ImportSetRowHelper().canReadImportSets();\n```\n\n## Scoped ScopedRenderProperties - getViewName()\n\nReturns the name of the view in use.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the view being used. |\n\n### Example\n\nThe following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\nRP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined\n```\n\n## Scoped ScopedRenderProperties - getWindowProperties()\n\nReturns the window's properties.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| Object | The window's properties |\n\n## Scoped ScopedRenderProperties - isInDevStudio()\n\nReturns true if the page is part of Studio.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true if the page is part of Studio. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped ScopedRenderProperties - isInteractive()\n\nReturns true if this is an interactive session. An interactive session is when a user\nhas logged in as opposed to a REST request.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if this is an interactive session. |\n\n## Scoped ScopedRenderProperties - isManyToMany()\n\nReturns true when the `sysparm_collection_related_file` URL parameter is\nset.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Returns true when the `sysparm_collection_related_file` URL parameter is set. |\n\n### Example\n\nThe following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped ScopedRenderProperties - isRelatedList()\n\nReturns true when the `sys_is_related_list` URL-parameter is true.\nReturns false if the parameter is not present.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if the URL parameter `sys_is_related_list` is true. |\n\n### Example\n\nThe following example is used in a condition for a UI action listed in the UI Actions [sys\\_ui\\_action] table. See also UI actions.\n\n```None\ncurrent.canCreate() && RP.isRelatedList()\n```\n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":19,"numItemsPerPage":100,"numTotalItems":60967,"offset":1900,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc4NjMxNzc3NSwianRpIjoiZWZiZjU5YWEtOGRjOC00MDJmLThmYjUtYzQzN2RiNjhhYzlmIiwic3ViIjoiL2RhdGFzZXRzL1NlcnZpY2VOb3ctQUkvc2VydmljZW5vdy1kb2NzIiwiZXhwIjoxNzg2MzIxMzc1LCJpc3MiOiJodHRwczovL2h1Z2dpbmdmYWNlLmNvIn0.6FkuxHzL2yorKKNKrGOZi-i9KFvb3Ojmv5jhvtDN5m5vjL2YWll3oaBbFqn8rmGgAJXqysFsyoeZEW2jKMNNBQ","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":60967,"numBytesParquet":444661170},{"config":"default","split":"train_chunks","numRows":287271,"numBytesParquet":525744610}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
loc string | api string | lastmod string | changefreq string | priority float64 | sitemappart string | locale string | bundle string | page_id string | release string | title string | description string | keywords list | breadcrumbs list | html_content string | page_content dict | clean_text string | rich_text string |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/FieldReadConfiguration/concept/FieldReadConfigurationiOSStruct.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/FieldReadConfiguration/concept/FieldReadConfigurationiOSStruct.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/FieldReadConfiguration/concept/FieldReadConfigurationiOSStruct.html | vancouver | FieldReadConfiguration structure - iOS | The FieldReadConfiguration structure enables you to configure which fields to fetch from a ServiceNow instance table and in which format. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/FieldReadConfiguration/concept/FieldReadConfigurationiOSStruct.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/FieldReadConfiguration/concept/FieldRea... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# FieldReadConfiguration structure - iOS
The FieldReadConfiguration structure enables you to configure which
fields to fetch from a ServiceNow instan... | ---
title: FieldReadConfiguration structure - iOS
description: The FieldReadConfiguration structure enables you to configure which fields
to fetch from a ServiceNow instance table and in which format.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/FieldWriteOptions/concept/FieldWriteOptionsiOSStruct.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/FieldWriteOptions/concept/FieldWriteOptionsiOSStruct.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/FieldWriteOptions/concept/FieldWriteOptionsiOSStruct.html | vancouver | FieldWriteOptions class - iOS | The FieldWriteOptions class provides functions that set the options for updating or creating fields in a record on a ServiceNow instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/FieldWriteOptions/concept/FieldWriteOptionsiOSStruct.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/FieldWriteOptions/concept/FieldWriteOptionsiOSStr... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# FieldWriteOptions class - iOS
The FieldWriteOptions class provides functions that set the options
for updating or creating fields in a record on a ... | ---
title: FieldWriteOptions class - iOS
description: The FieldWriteOptions class provides functions that set the options for
updating or creating fields in a record on a ServiceNow instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API refer... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/Filter/concept/FilteriOSStructure.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/Filter/concept/FilteriOSStructure.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/Filter/concept/FilteriOSStructure.html | vancouver | Filter structure - iOS | The Filter structure provides the ability to configure filters that define the data to return in the return results of a REST endpoint query. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/Filter/concept/FilteriOSStructure.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/Filter/concept/FilteriOSStructure.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Filter structure - iOS
The Filter structure provides the ability to configure filters that
define the data to return in the return results of a RES... | ---
title: Filter structure - iOS
description: The Filter structure provides the ability to configure filters that define
the data to return in the return results of a REST endpoint query.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API referenc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIEndpoint/concept/NowAPIEndpointiOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIEndpoint/concept/NowAPIEndpointiOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIEndpoint/concept/NowAPIEndpointiOSProtocol.html | vancouver | NowAPIEndpoint protocol - iOS | The NowAPIEndpoint protocol provides an interface for accessing any publicly exposed ServiceNow REST APIs. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIEndpoint/concept/NowAPIEndpointiOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIEndpoint/concept/NowAPIEndpointiOSProtocol.html... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAPIEndpoint protocol - iOS
The NowAPIEndpoint protocol provides an interface for accessing any
publicly exposed ServiceNow REST APIs.
Table 1. ... | ---
title: NowAPIEndpoint protocol - iOS
description: The NowAPIEndpoint protocol provides an interface for accessing any publicly
exposed ServiceNow REST APIs.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver r... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIService/concept/NowAPIServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIService/concept/NowAPIServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIService/concept/NowAPIServiceiOSAPI.html | vancouver | NowAPIService class - iOS | The NowAPIService class provides functions that enable you to perform requests to a specified ServiceNow REST API. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIService/concept/NowAPIServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAPIService/concept/NowAPIServiceiOSAPI.html"><div class="... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAPIService class - iOS
The NowAPIService class provides functions that enable you to
perform requests to a specified ServiceNow REST API.
Table... | ---
title: NowAPIService class - iOS
description: The NowAPIService class provides functions that enable you to perform
requests to a specified ServiceNow REST API.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouv... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsService/concept/NowAnalyticsServiceiOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsService/concept/NowAnalyticsServiceiOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsService/concept/NowAnalyticsServiceiOSProtocol.html | vancouver | NowAnalyticsService protocol - iOS | The NowAnalyticsService protocol provides functions that enable you to configure analytics properties, user settings, and events for managing the collection of user analytics data. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsService/concept/NowAnalyticsServiceiOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsService/concept/NowAnalyticsSer... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAnalyticsService protocol - iOS
The NowAnalyticsService protocol provides functions that enable you
to configure analytics properties, user sett... | ---
title: NowAnalyticsService protocol - iOS
description: The NowAnalyticsService protocol provides functions that enable you to
configure analytics properties, user settings, and events for managing the collection
of user analytics data.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsServiceDelegate/concept/NowAnalyticsServiceDeliOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsServiceDelegate/concept/NowAnalyticsServiceDeliOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsServiceDelegate/concept/NowAnalyticsServiceDeliOSProtocol.html | vancouver | NowAnalyticsServiceDelegate protocol - iOS | The NowAnalyticsServiceDelegate protocol provides callback functions that provide information about the starting and ending of a user session and screen change detection. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsServiceDelegate/concept/NowAnalyticsServiceDeliOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAnalyticsServiceDelegate/conc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAnalyticsServiceDelegate protocol - iOS
The NowAnalyticsServiceDelegate protocol provides callback functions
that provide information about the ... | ---
title: NowAnalyticsServiceDelegate protocol - iOS
description: The NowAnalyticsServiceDelegate protocol provides callback functions
that provide information about the starting and ending of a user session and screen
change detection.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
-... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachment/concept/NowAttachmentiOSStructure.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachment/concept/NowAttachmentiOSStructure.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachment/concept/NowAttachmentiOSStructure.html | vancouver | NowAttachment structure - iOS | The NowAttachment structure provides functions that enable you to validate attachments by comparing their computed hash. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachment/concept/NowAttachmentiOSStructure.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachment/concept/NowAttachmentiOSStructure.html">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAttachment structure - iOS
The NowAttachment structure provides functions that enable you to
validate attachments by comparing their computed ha... | ---
title: NowAttachment structure - iOS
description: The NowAttachment structure provides functions that enable you to validate
attachments by comparing their computed hash.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
T... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentMetadata/concept/NowAttachmentMetadataiOSStructure.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentMetadata/concept/NowAttachmentMetadataiOSStructure.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentMetadata/concept/NowAttachmentMetadataiOSStructure.html | vancouver | NowAttachmentMetadata structure - iOS | The NowAttachmentMetadata structure provides functions that enable you to encode and manage attachment metadata. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentMetadata/concept/NowAttachmentMetadataiOSStructure.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentMetadata/concept/NowAttac... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAttachmentMetadata structure - iOS
The NowAttachmentMetadata structure provides functions that enable
you to encode and manage attachment metada... | ---
title: NowAttachmentMetadata structure - iOS
description: The NowAttachmentMetadata structure provides functions that enable you
to encode and manage attachment metadata.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
T... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentService/concept/NowAttachmentServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentService/concept/NowAttachmentServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentService/concept/NowAttachmentServiceiOSAPI.html | vancouver | NowAttachmentService class - iOS | The NowAttachmentService class provides functions that enable you to upload and query attachments that are associated with records within a table on a ServiceNow instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentService/concept/NowAttachmentServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentService/concept/NowAttachmentServ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAttachmentService class - iOS
The NowAttachmentService class provides functions that enable you to
upload and query attachments that are associa... | ---
title: NowAttachmentService class - iOS
description: The NowAttachmentService class provides functions that enable you to
upload and query attachments that are associated with records within a table on
a ServiceNow instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile S... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentUploadConfiguration/concept/NowAttachUploadConfigiOSStruct.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentUploadConfiguration/concept/NowAttachUploadConfigiOSStruct.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentUploadConfiguration/concept/NowAttachUploadConfigiOSStruct.html | vancouver | NowAttachmentUploadConfiguration structure - iOS | The NowAttachmentUploadConfiguration structure enables you to define the configuration information for an attachment that you are uploading to your ServiceNow instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentUploadConfiguration/concept/NowAttachUploadConfigiOSStruct.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowAttachmentUploadConfigurati... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowAttachmentUploadConfiguration structure - iOS
The NowAttachmentUploadConfiguration structure enables you to define
the configuration information... | ---
title: NowAttachmentUploadConfiguration structure - iOS
description: The NowAttachmentUploadConfiguration structure enables you to define
the configuration information for an attachment that you are uploading to your ServiceNow
instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API referen... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChat/concept/NowChatiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChat/concept/NowChatiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowChat/concept/NowChatiOSAPI.html | vancouver | NowChat API - iOS | The NowChat API is a top-level global API that enables users to instantiate a NowChat service instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChat/concept/NowChatiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChat/concept/NowChatiOSAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowChat API - iOS
The NowChat API is a top-level global API that enables users to
instantiate a NowChat service instance.
## NowChat - makeChatSer... | ---
title: NowChat API - iOS
description: The NowChat API is a top-level global API that enables users to instantiate
a NowChat service instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release is no lo... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatColoring/concept/NowChatColoringiOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatColoring/concept/NowChatColoringiOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowChatColoring/concept/NowChatColoringiOSProtocol.html | vancouver | NowChatColoring protocol - iOS | The NowChatColoring protocol defines default colors for the elements in the Live Agent and Virtual Agent chat UI. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatColoring/concept/NowChatColoringiOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatColoring/concept/NowChatColoringiOSProtocol.... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowChatColoring protocol - iOS
The NowChatColoring protocol defines default colors for the elements
in the Live Agent and Virtual Agent chat UI.
Y... | ---
title: NowChatColoring protocol - iOS
description: The NowChatColoring protocol defines default colors for the elements
in the Live Agent and Virtual Agent chat UI.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Van... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatService/concept/NowChatServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatService/concept/NowChatServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowChatService/concept/NowChatServiceiOSAPI.html | vancouver | NowChatService class - iOS | The NowChatService class provides Virtual and Live Agent chat capabilities. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatService/concept/NowChatServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatService/concept/NowChatServiceiOSAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowChatService class - iOS
The NowChatService class provides Virtual and Live Agent chat capabilities.
Using this class you can start and stop cha... | ---
title: NowChatService class - iOS
description: The NowChatService class provides Virtual and Live Agent chat capabilities.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release is no longer supported. As su... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatServiceDelegate/concept/NowChatServiceDelegateiOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatServiceDelegate/concept/NowChatServiceDelegateiOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowChatServiceDelegate/concept/NowChatServiceDelegateiOSProtocol.html | vancouver | NowChatServiceDelegate protocol - iOS | The NowChatServiceDelegate protocol provides callbacks for notification of actions within the NowChatService such as a request to open a URL or dismiss the chat view controller. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatServiceDelegate/concept/NowChatServiceDelegateiOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowChatServiceDelegate/concept/NowCha... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowChatServiceDelegate protocol - iOS
The NowChatServiceDelegate protocol provides callbacks for
notification of actions within the NowChatService ... | ---
title: NowChatServiceDelegate protocol - iOS
description: The NowChatServiceDelegate protocol provides callbacks for notification
of actions within the NowChatService such as a request to open a URL or dismiss
the chat view controller.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowCoreService/concept/NowCoreServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowCoreService/concept/NowCoreServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowCoreService/concept/NowCoreServiceiOSAPI.html | vancouver | NowCoreService class - iOS | The NowCoreService class provides fundamental services to the various SDK feature services. This class should only be instantiated by NowSDK. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowCoreService/concept/NowCoreServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowCoreService/concept/NowCoreServiceiOSAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowCoreService class - iOS
The NowCoreService class provides fundamental services to the
various SDK feature services. This class should only be in... | ---
title: NowCoreService class - iOS
description: The NowCoreService class provides fundamental services to the various
SDK feature services. This class should only be instantiated by NowSDK.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API refe... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowData/concept/NowDataAPIiOS.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowData/concept/NowDataAPIiOS.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowData/concept/NowDataAPIiOS.html | vancouver | NowData framework - iOS | The NowData framework contains methods that enable the instantiation of NowData services, such as NowGraphQLService, NowTableService, NowAPIService (for custom APIs), and NowAttachmentService. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowData/concept/NowDataAPIiOS.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowData/concept/NowDataAPIiOS.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowData framework - iOS
The NowData framework contains methods that enable the instantiation of NowData services, such as NowGraphQLService, NowTab... | ---
title: NowData framework - iOS
description: The NowData framework contains methods that enable the instantiation
of NowData services, such as NowGraphQLService, NowTableService, NowAPIService (for
custom APIs), and NowAttachmentService.
keywords: []
breadcrumbs:
- API implementation and reference
- API referenc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowGraphQLService/concept/NowGraphQLServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowGraphQLService/concept/NowGraphQLServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowGraphQLService/concept/NowGraphQLServiceiOSAPI.html | vancouver | NowGraphQLService class - iOS | The NowGraphQLService class provides functions that enable you to make requests using GraphQL queries against data on your ServiceNow instance through its GraphQL REST API. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowGraphQLService/concept/NowGraphQLServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowGraphQLService/concept/NowGraphQLServiceiOSAPI.ht... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowGraphQLService class - iOS
The NowGraphQLService class provides functions that enable you to
make requests using GraphQL queries against data on... | ---
title: NowGraphQLService class - iOS
description: The NowGraphQLService class provides functions that enable you to make
requests using GraphQL queries against data on your ServiceNow instance through
its GraphQL REST API.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowLoggingService/concept/NowLoggingServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowLoggingService/concept/NowLoggingServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowLoggingService/concept/NowLoggingServiceiOSAPI.html | vancouver | NowLoggingService class - iOS | The NowLoggingService class provides functions that provide logging capabilities to feature services with the NowSDK. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowLoggingService/concept/NowLoggingServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowLoggingService/concept/NowLoggingServiceiOSAPI.ht... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowLoggingService class - iOS
The NowLoggingService class provides functions that provide logging
capabilities to feature services with the NowSDK.... | ---
title: NowLoggingService class - iOS
description: The NowLoggingService class provides functions that provide logging capabilities
to feature services with the NowSDK.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowPush/concept/NowPushiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowPush/concept/NowPushiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowPush/concept/NowPushiOSAPI.html | vancouver | NowPush API - iOS | The NowPush API is a top-level global API that enables users to instantiate a NowPush service instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowPush/concept/NowPushiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowPush/concept/NowPushiOSAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowPush API - iOS
The NowPush API is a top-level global API that enables users to
instantiate a NowPush service instance.
## NowPush - makePushSer... | ---
title: NowPush API - iOS
description: The NowPush API is a top-level global API that enables users to instantiate
a NowPush service instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release is no lo... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushPayload/concept/NowPushPayloadiOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushPayload/concept/NowPushPayloadiOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowPushPayload/concept/NowPushPayloadiOSProtocol.html | vancouver | NowPushPayload protocol - iOS | NowPushPayload is a generic protocol you can use to define a push notification protocol within the NowSDK framework. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushPayload/concept/NowPushPayloadiOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushPayload/concept/NowPushPayloadiOSProtocol.html... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowPushPayload protocol - iOS
NowPushPayload is a generic protocol you can use to define a push notification protocol within the `NowSDK` framework... | ---
title: NowPushPayload protocol - iOS
description: NowPushPayload is a generic protocol you can use to define a push notification
protocol within the NowSDK framework.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The V... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushService/concept/NowPushServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushService/concept/NowPushServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowPushService/concept/NowPushServiceiOSAPI.html | vancouver | NowPushService class - iOS | The NowPushService class provides functions that enable interaction with the Push Notification service. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushService/concept/NowPushServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowPushService/concept/NowPushServiceiOSAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowPushService class - iOS
The NowPushService class provides functions that enable interaction
with the Push Notification service.
Table 1. Proper... | ---
title: NowPushService class - iOS
description: The NowPushService class provides functions that enable interaction with
the Push Notification service.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowRecord/concept/NowRecordiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowRecord/concept/NowRecordiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowRecord/concept/NowRecordiOSAPI.html | vancouver | NowRecord class - iOS | The NowRecord class defines a model that represents a record in a table on a ServiceNow instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowRecord/concept/NowRecordiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowRecord/concept/NowRecordiOSAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowRecord class - iOS
The NowRecord class defines a model that represents a record in a
table on a ServiceNow instance.
Table 1. Properties
| Name... | ---
title: NowRecord class - iOS
description: The NowRecord class defines a model that represents a record in a table
on a ServiceNow instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release is no long... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDK/concept/NowSDKAPIiOS.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDK/concept/NowSDKAPIiOS.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowSDK/concept/NowSDKAPIiOS.html | vancouver | NowSDK framework - iOS | The NowSDK framework contains methods that enable the instantiation of various feature services. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDK/concept/NowSDKAPIiOS.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDK/concept/NowSDKAPIiOS.html"><div class="wm">The Vancouver release is... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowSDK framework - iOS
The NowSDK framework contains methods that enable the instantiation of various feature services.
## NowSDK - configure(with... | ---
title: NowSDK framework - iOS
description: The NowSDK framework contains methods that enable the instantiation of
various feature services.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release is no long... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDKConfiguration/concept/NowSDKConfigurationiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDKConfiguration/concept/NowSDKConfigurationiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowSDKConfiguration/concept/NowSDKConfigurationiOSAPI.html | vancouver | NowSDKConfiguration class - iOS | The NowSDKConfiguration class contains configuration information needed to initialize the NowSDK. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDKConfiguration/concept/NowSDKConfigurationiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowSDKConfiguration/concept/NowSDKConfigurationi... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowSDKConfiguration class - iOS
The NowSDKConfiguration class contains configuration information
needed to initialize the NowSDK.
Table 1. Propert... | ---
title: NowSDKConfiguration class - iOS
description: The NowSDKConfiguration class contains configuration information needed
to initialize the NowSDK.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowService/concept/NowServiceiOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowService/concept/NowServiceiOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowService/concept/NowServiceiOSProtocol.html | vancouver | NowService protocol - iOS | The NowService protocol provides a single interface to the NowSDK for all feature services. It defines the configuration parameters needed to access your ServiceNow instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowService/concept/NowServiceiOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowService/concept/NowServiceiOSProtocol.html"><div class="wm... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowService protocol - iOS
The NowService protocol provides a single interface to the NowSDK
for all feature services. It defines the configuration ... | ---
title: NowService protocol - iOS
description: The NowService protocol provides a single interface to the NowSDK for
all feature services. It defines the configuration parameters needed to access your
ServiceNow instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK A... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowServiceConfiguration/concept/NowServiceConfigurationiOSStruct.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowServiceConfiguration/concept/NowServiceConfigurationiOSStruct.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowServiceConfiguration/concept/NowServiceConfigurationiOSStruct.html | vancouver | NowServiceConfiguration structure - iOS | The NowServiceConfiguration structure defines configuration information for a feature service. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowServiceConfiguration/concept/NowServiceConfigurationiOSStruct.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowServiceConfiguration/concept/NowSe... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowServiceConfiguration structure - iOS
The NowServiceConfiguration structure defines configuration
information for a feature service.
Table 1. Pr... | ---
title: NowServiceConfiguration structure - iOS
description: The NowServiceConfiguration structure defines configuration information
for a feature service.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver rel... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowTableService/concept/NowTableServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowTableService/concept/NowTableServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowTableService/concept/NowTableServiceiOSAPI.html | vancouver | NowTableService class - iOS | The NowTableService class provides functions that enable you to perform create, read, update, and delete operations on records of existing ServiceNow tables. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowTableService/concept/NowTableServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowTableService/concept/NowTableServiceiOSAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowTableService class - iOS
The NowTableService class provides functions that enable you to
perform create, read, update, and delete operations on ... | ---
title: NowTableService class - iOS
description: The NowTableService class provides functions that enable you to perform
create, read, update, and delete operations on records of existing ServiceNow tables.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mo... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWeb/concept/NowWebiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWeb/concept/NowWebiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowWeb/concept/NowWebiOSAPI.html | vancouver | NowWeb API - iOS | The NowWeb API is a top-level global API that enables uses to instantiate a NowWeb service instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWeb/concept/NowWebiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWeb/concept/NowWebiOSAPI.html"><div class="wm">The Vancouver release is... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowWeb API - iOS
The NowWeb API is a top-level global API that enables uses to instantiate a NowWeb service instance.
## NowWeb - makeWebService(i... | ---
title: NowWeb API - iOS
description: The NowWeb API is a top-level global API that enables uses to instantiate
a NowWeb service instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release is no longer... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebService/concept/NowWebServiceiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebService/concept/NowWebServiceiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowWebService/concept/NowWebServiceiOSAPI.html | vancouver | NowWebService class - iOS | The NowWebService class provides functions that enable the browsing of web pages on a ServiceNow instance. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebService/concept/NowWebServiceiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebService/concept/NowWebServiceiOSAPI.html"><div class="... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowWebService class - iOS
The NowWebService class provides functions that enable the browsing
of web pages on a ServiceNow instance.
Table 1. Prop... | ---
title: NowWebService class - iOS
description: The NowWebService class provides functions that enable the browsing of
web pages on a ServiceNow instance.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver relea... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewController/concept/NWebViewControlleriOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewController/concept/NWebViewControlleriOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewController/concept/NWebViewControlleriOSAPI.html | vancouver | NowWebViewController class - iOS | The NowWebViewController class provides functions that enable you to manage a web viewer. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewController/concept/NWebViewControlleriOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewController/concept/NWebViewControlleri... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowWebViewController class - iOS
The NowWebViewController class provides functions that enable you to
manage a web viewer.
## NowWebViewController... | ---
title: NowWebViewController class - iOS
description: The NowWebViewController class provides functions that enable you to
manage a web viewer.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
- Mobile SDK API reference - iOS
---
The Vancouver release is no l... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewControllerDelegate/concept/NWViewControllerDelegateiOSProtocol.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewControllerDelegate/concept/NWViewControllerDelegateiOSProtocol.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewControllerDelegate/concept/NWViewControllerDelegateiOSProtocol.html | vancouver | NowWebViewControllerDelegate protocol - iOS | The NowWebViewControllerDelegate protocol provides callbacks for notification of issues within the NowWebViewController processing such as when a flow ends or a navigation fails. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewControllerDelegate/concept/NWViewControllerDelegateiOSProtocol.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/NowWebViewControllerDelegate/... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NowWebViewControllerDelegate protocol - iOS
The NowWebViewControllerDelegate protocol provides callbacks for
notification of issues within the NowW... | ---
title: NowWebViewControllerDelegate protocol - iOS
description: The NowWebViewControllerDelegate protocol provides callbacks for notification
of issues within the NowWebViewController processing such as when a flow ends or
a navigation fails.
keywords: []
breadcrumbs:
- API implementation and reference
- API re... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/Paginator/concept/PaginatorIOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/Paginator/concept/PaginatorIOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/Paginator/concept/PaginatorIOSAPI.html | vancouver | Paginator API - iOS | The Paginator class provides methods for iterating through a record set returned by a call to the ServiceNow Table API through the NowTableService. It is the object that is returned by the NowTableService paginator() methods. Do not call this method | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference",
"Mobile SDK API reference - iOS"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/Paginator/concept/PaginatorIOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/Paginator/concept/PaginatorIOSAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Paginator API - iOS
The Paginator class provides methods for iterating through a record
set returned by a call to the ServiceNow
Table API through ... | ---
title: Paginator API - iOS
description: The Paginator class provides methods for iterating through a record set
returned by a call to the ServiceNow Table API through the NowTableService. It is
the object that is returned by the NowTableService paginator() methods. Do not call
this method
keywords: []
breadcr... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/concept/MobileSDKiOSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MobileSDKiOS/concept/MobileSDKiOSAPI.html | 2025-04-03 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MobileSDKiOS/concept/MobileSDKiOSAPI.html | vancouver | Mobile SDK API reference - iOS | The Mobile SDK for iOS provides the classes necessary to interface iOS-based devices with the ServiceNow platform. | [] | [
"API implementation and reference",
"API reference",
"Mobile SDK API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/concept/MobileSDKiOSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MobileSDKiOS/concept/MobileSDKiOSAPI.html"><div class="wm">The Vancouver release is no long... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Mobile SDK API reference - iOS
The Mobile SDK for iOS provides the classes necessary to interface
iOS-based devices with the ServiceNow platform.
... | ---
title: Mobile SDK API reference - iOS
description: The Mobile SDK for iOS provides the classes necessary to interface iOS-based
devices with the ServiceNow platform.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Mobile SDK API reference
---
The Vancouver release is no longer supp... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MonitorMIDServer/concept/c_MonitorMIDServerAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/MonitorMIDServer/concept/c_MonitorMIDServerAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/MonitorMIDServer/concept/c_MonitorMIDServerAPI.html | vancouver | MonitorMIDServer - Global | Monitors MID servers using the heartbeat probe to check for MID servers that are down, sends heartbeat requests, and kills old heartbeat requests. | [
"MonitorMIDServer API",
"MonitorMIDServer",
"killOldRequests()",
"markDowners()",
"monitor()",
"MonitorMIDServer()",
"sendHeartbeatRequests()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MonitorMIDServer/concept/c_MonitorMIDServerAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/MonitorMIDServer/concept/c_MonitorMIDServerAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# MonitorMIDServer - Global
Monitors MID servers using the heartbeat probe to check for MID servers that are down,
sends heartbeat requests, and kill... | ---
title: MonitorMIDServer - Global
description: Monitors MID servers using the heartbeat probe to check for MID servers
that are down, sends heartbeat requests, and kills old heartbeat requests.
keywords:
- MonitorMIDServer API
- MonitorMIDServer
- killOldRequests()
- markDowners()
- monitor()
- MonitorMIDServer()
... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NameValuePairs/concept/c_NameValuePairsAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NameValuePairs/concept/c_NameValuePairsAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NameValuePairs/concept/c_NameValuePairsAPI.html | vancouver | NameValuePairs - Global | Converts between maps and strings representing the name/value pairs in the map. | [
"NameValuePairs API",
"NameValuePairs",
"mapToString()",
"NameValuePairs(String stringForm)",
"NameValuePairs(Object mapForm)",
"quotify(Object value)",
"stringToMap()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NameValuePairs/concept/c_NameValuePairsAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NameValuePairs/concept/c_NameValuePairsAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NameValuePairs - Global
Converts between maps and strings representing the name/value pairs in the
map.
The string form is: <name> = <value>, <nam... | ---
title: NameValuePairs - Global
description: Converts between maps and strings representing the name/value pairs in
the map.
keywords:
- NameValuePairs API
- NameValuePairs
- mapToString()
- NameValuePairs(String stringForm)
- NameValuePairs(Object mapForm)
- quotify(Object value)
- stringToMap()
breadcrumbs:
- AP... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NetwareHandler/concept/c_NetwareHandlerAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NetwareHandler/concept/c_NetwareHandlerAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NetwareHandler/concept/c_NetwareHandlerAPI.html | vancouver | NetwareHandler - Global | The NetwareHandler API implements an SNMP handler for Netware OS. | [
"NetwareHandler API",
"NetwareHandler",
"classifyAndIdentify()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NetwareHandler/concept/c_NetwareHandlerAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NetwareHandler/concept/c_NetwareHandlerAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NetwareHandler - Global
The NetwareHandler API implements an SNMP handler for Netware
OS.
This handler is designed to be invoked by Classify.java ... | ---
title: NetwareHandler - Global
description: The NetwareHandler API implements an SNMP handler for Netware OS.
keywords:
- NetwareHandler API
- NetwareHandler
- classifyAndIdentify()
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer support... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Notify/concept/c_NotifyAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Notify/concept/c_NotifyAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Notify/concept/c_NotifyAPI.html | vancouver | Notify - Global | The Notify API allows you to interact with Notify calls and SMS messages using scripts. | [
"Notify",
"API",
"call(String notifyPhoneNumber",
"String toPhoneNumber",
"GlideRecord conferenceCall",
"GlideRecord conferenceCallRecord",
"String userSysId",
"String groupSysId",
"GlideRecord sourceRecord)",
"conferenceCall(GlideRecord sourceRecord)",
"dequeueCall(GlideRecord callRecord)",
"... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Notify/concept/c_NotifyAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Notify/concept/c_NotifyAPI.html"><div class="wm">The Vancouver release is no longer supported. As suc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Notify - Global
The Notify API allows you to interact with Notify calls and SMS
messages using scripts.
Access the global Notify class and its ass... | ---
title: Notify - Global
description: The Notify API allows you to interact with Notify calls and SMS messages
using scripts.
keywords:
- Notify
- API
- call(String notifyPhoneNumber
- String toPhoneNumber
- GlideRecord conferenceCall
- GlideRecord conferenceCallRecord
- String userSysId
- String groupSysId
- Glide... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Notify2WebRTCClient/concept/c_Notify2WebRTCClient.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Notify2WebRTCClient/concept/c_Notify2WebRTCClient.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Notify2WebRTCClient/concept/c_Notify2WebRTCClient.html | vancouver | NotifyClient - Client | The NotifyClient API allows you use Notify telephony functionality, such as making and receiving calls, from a web browser. | [
"NotifyClient",
"Notify WebRTC Client",
"Object notifyConfig",
"Boolean initializeVendorClientLazily",
"NotifyClient",
"addEventListener(String event",
"Function fn)",
"call(Object identifier)",
"destroy()",
"forwardCall(Object argument)",
"getAvailableClients(Function callback)",
"getParentId... | [
"API implementation and reference",
"API reference",
"Client API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Notify2WebRTCClient/concept/c_Notify2WebRTCClient.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Notify2WebRTCClient/concept/c_Notify2WebRTCClient.html"><div class="wm">The Va... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyClient - Client
The NotifyClient API allows you use Notify telephony functionality, such as making and
receiving calls, from a web browser.
... | ---
title: NotifyClient - Client
description: The NotifyClient API allows you use Notify telephony functionality, such
as making and receiving calls, from a web browser.
keywords:
- NotifyClient
- Notify WebRTC Client
- Object notifyConfig
- Boolean initializeVendorClientLazily
- NotifyClient
- addEventListener(Strin... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyAction/concept/c_NotifyActionApi.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyAction/concept/c_NotifyActionApi.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyAction/concept/c_NotifyActionApi.html | vancouver | NotifyAction - Global | The NotifyAction API allows you to define actions to send to a telephony provider. | [
"NotifyAction",
"addConference()",
"NotifyAction",
"addConference.setEndOnExit(Boolean endOnExit)",
"addConference.setHangupOnStar(Boolean hangupOnStar)",
"addConference.setMuted(Boolean muted)",
"addConference.setName(String name)",
"addConference.setRecord(Boolean record)",
"addConference.setStart... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyAction/concept/c_NotifyActionApi.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyAction/concept/c_NotifyActionApi.html"><div class="wm">The Vancouver release is no ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyAction - Global
The NotifyAction API allows you to define actions to send to a
telephony provider.
You add actions to a NotifyAction object ... | ---
title: NotifyAction - Global
description: The NotifyAction API allows you to define actions to send to a telephony
provider.
keywords:
- NotifyAction
- addConference()
- NotifyAction
- addConference.setEndOnExit(Boolean endOnExit)
- addConference.setHangupOnStar(Boolean hangupOnStar)
- addConference.setMuted(Bool... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyConferenceUtils/concept/NotifyConferenceUtils.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyConferenceUtils/concept/NotifyConferenceUtils.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyConferenceUtils/concept/NotifyConferenceUtils.html | vancouver | NotifyConferenceUtil - Scoped, Global | The NotifyConferenceUtil API provides methods to manage Notify conference calls and SMS messages for various telephony service providers, such as Zoom and Webex. | [
"NotifyConferenceUtil",
"Notify participant management",
"Notify participant",
"NotifyConferenceUtils",
"addToConferenceByPhoneNumber(String toNumber",
"GlideRecord confGR",
"addToConferenceByUserId(String userId",
"GlideRecord confGR)",
"doConferenceAction(String action",
"Object data)",
"getCo... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyConferenceUtils/concept/NotifyConferenceUtils.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyConferenceUtils/concept/NotifyConferenceUtils.html"><div class="wm">Th... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyConferenceUtil - Scoped, Global
The NotifyConferenceUtil API provides methods to manage Notify conference calls and SMS messages for various ... | ---
title: NotifyConferenceUtil - Scoped, Global
description: The NotifyConferenceUtil API provides methods to manage Notify conference
calls and SMS messages for various telephony service providers, such as Zoom and
Webex.
keywords:
- NotifyConferenceUtil
- Notify participant management
- Notify participant
- Noti... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyJsTelephonyDriver/concept/NotifyJsTelephonyDriverAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyJsTelephonyDriver/concept/NotifyJsTelephonyDriverAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyJsTelephonyDriver/concept/NotifyJsTelephonyDriverAPI.html | vancouver | NotifyJsTelephonyDriver - Global | The NotifyJsTelephonyDriver API provides methods that you can use to obtain information about the capabilities of the associated telephony driver. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyJsTelephonyDriver/concept/NotifyJsTelephonyDriverAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyJsTelephonyDriver/concept/NotifyJsTelephonyDriverAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyJsTelephonyDriver - Global
The NotifyJsTelephonyDriver API provides methods that you can use to
obtain information about the capabilities of ... | ---
title: NotifyJsTelephonyDriver - Global
description: The NotifyJsTelephonyDriver API provides methods that you can use to
obtain information about the capabilities of the associated telephony driver.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vanco... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyNow/concept/c_NotifyNow.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyNow/concept/c_NotifyNow.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyNow/concept/c_NotifyNow.html | vancouver | NotifyNow (Legacy) - Global | The legacy NotifyNow API provides functionality for sending emails, sending SMS messages, and setting up conference calls. | [
"NotifyNow",
"Legacy Notify",
"addConferenceCallParticipant(String conferenceCall",
"String participant)",
"getReadyState()",
"getStatus()",
"initiateConferenceCall(String",
"Strinng",
"GlideRecord",
"Boolean)",
"isCallable(String participant)",
"isSMSCapable()",
"isSMSCapable(String userID)... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyNow/concept/c_NotifyNow.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyNow/concept/c_NotifyNow.html"><div class="wm">The Vancouver release is no longer supported. ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyNow (Legacy) - Global
The legacy NotifyNow API provides functionality for sending emails,
sending SMS messages, and setting up conference cal... | ---
title: NotifyNow (Legacy) - Global
description: The legacy NotifyNow API provides functionality for sending emails, sending
SMS messages, and setting up conference calls.
keywords:
- NotifyNow
- Legacy Notify
- addConferenceCallParticipant(String conferenceCall
- String participant)
- getReadyState()
- getStatus(... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyOnTaskClient/concept/NotifyOnTaskClient.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyOnTaskClient/concept/NotifyOnTaskClient.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyOnTaskClient/concept/NotifyOnTaskClient.html | vancouver | NotifyOnTaskClient - Client | The NotifyOnTaskClient API provides methods for sending SMS messages or starting/managing a conference call for various telephony service providers, such as Zoom and WebEx. | [
"NotifyOnTaskClient",
"Notify On Task",
"NotifyConferenceAPI",
"addParticipants(Object data)",
"NotifyOnTaskClient",
"doConferenceAction(String action",
"Object data)",
"endConference(Object data)",
"NotifyConferenceUtils",
"getConferenceInputDataTemplate()",
"start(Object data)"
] | [
"API implementation and reference",
"API reference",
"Client API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyOnTaskClient/concept/NotifyOnTaskClient.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyOnTaskClient/concept/NotifyOnTaskClient.html"><div class="wm">The Vancouver ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyOnTaskClient - Client
The NotifyOnTaskClient API provides methods for sending SMS messages
or starting/managing a conference call for various... | ---
title: NotifyOnTaskClient - Client
description: The NotifyOnTaskClient API provides methods for sending SMS messages
or starting/managing a conference call for various telephony service providers,
such as Zoom and WebEx.
keywords:
- NotifyOnTaskClient
- Notify On Task
- NotifyConferenceAPI
- addParticipants(Obj... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyPhoneNumber/concept/c_NotifyPhoneNumberAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyPhoneNumber/concept/c_NotifyPhoneNumberAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyPhoneNumber/concept/c_NotifyPhoneNumberAPI.html | vancouver | NotifyPhoneNumber - Global | The NotifyPhoneNumber API allows you to query information about a Notify phone number. | [
"NotifyPhoneNumber",
"getDialCode()",
"NotifyPhoneNumber",
"getID()",
"getNumber()",
"getOwner()",
"getTerritory()",
"NotifyPhoneNumber",
"isShortCode",
"supportsConferenceCall()",
"supportsIncomingPhoneCall()",
"supportsIncomingSMS()",
"supportsOutgoingPhoneCall()",
"supportsOutgoingSMS()... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyPhoneNumber/concept/c_NotifyPhoneNumberAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyPhoneNumber/concept/c_NotifyPhoneNumberAPI.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyPhoneNumber - Global
The NotifyPhoneNumber API allows you to query information about a
Notify phone number.
Access the global NotifyPhoneNum... | ---
title: NotifyPhoneNumber - Global
description: The NotifyPhoneNumber API allows you to query information about a Notify
phone number.
keywords:
- NotifyPhoneNumber
- getDialCode()
- NotifyPhoneNumber
- getID()
- getNumber()
- getOwner()
- getTerritory()
- NotifyPhoneNumber
- isShortCode
- supportsConferenceCall()... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyPhoneNumberScoped/concept/NPNScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyPhoneNumberScoped/concept/NPNScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyPhoneNumberScoped/concept/NPNScopedAPI.html | vancouver | NotifyPhoneNumber - Scoped | The NotifyPhoneNumber API allows you to query information about a Notify phone number. | [
"Scoped NotifyPhoneNumber",
"Scoped NotifyPhoneNumber",
"getDialCode()",
"getID()",
"Scoped NotifyPhoneNumber",
"getNumber()",
"getOwner()",
"getTerritory()",
"supportsConferenceCall()",
"supportsIncomingPhoneCall()",
"supportsIncomingSMS()",
"supportsOutgoingPhoneCall()",
"supportsOutgoingS... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyPhoneNumberScoped/concept/NPNScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyPhoneNumberScoped/concept/NPNScopedAPI.html"><div class="wm">The Vancouver re... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyPhoneNumber - Scoped
The NotifyPhoneNumber API allows you to query information about a
Notify phone number.
Execute the scoped NotifyPhoneNu... | ---
title: NotifyPhoneNumber - Scoped
description: The NotifyPhoneNumber API allows you to query information about a Notify
phone number.
keywords:
- Scoped NotifyPhoneNumber
- Scoped NotifyPhoneNumber
- getDialCode()
- getID()
- Scoped NotifyPhoneNumber
- getNumber()
- getOwner()
- getTerritory()
- supportsConferenc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifySMS/concept/NotifySMSAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifySMS/concept/NotifySMSAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifySMS/concept/NotifySMSAPI.html | vancouver | NotifySMS - Global | The NotifySMS API provides methods that enable you to send Short Message Service (SMS) messages from Notify telephone numbers to devices using either their telephone numbers or a GlideRecord that has a field that contains telephone number information. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifySMS/concept/NotifySMSAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifySMS/concept/NotifySMSAPI.html"><div class="wm">The Vancouver release is no longer supported... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifySMS - Global
The NotifySMS API provides methods that enable you to send Short
Message Service (SMS) messages from Notify telephone numbers to... | ---
title: NotifySMS - Global
description: The NotifySMS API provides methods that enable you to send Short Message
Service (SMS) messages from Notify telephone numbers to devices using either their
telephone numbers or a GlideRecord that has a field that contains telephone number
information.
keywords: []
breadc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyScoped/concept/notifyScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyScoped/concept/notifyScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyScoped/concept/notifyScopedAPI.html | vancouver | NotifyScoped - Scoped | The NotifyScoped API allows you to interact with Notify calls and SMS messages using scripts. | [
"NotifyScoped",
"API",
"NotifyScoped",
"call(String notifyPhoneNumber",
"String toPhoneNumber",
"GlideRecord conferenceCall",
"GlideRecord conferenceCallRecord",
"String userSysId",
"String groupSysId",
"GlideRecord sourceRecord)",
"conferenceCall(GlideRecord sourceRecord)",
"dequeueCall(Glide... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyScoped/concept/notifyScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyScoped/concept/notifyScopedAPI.html"><div class="wm">The Vancouver release is no long... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyScoped - Scoped
The NotifyScoped API allows you to interact with Notify calls and
SMS messages using scripts.
Execute the NotifyScoped class... | ---
title: NotifyScoped - Scoped
description: The NotifyScoped API allows you to interact with Notify calls and SMS
messages using scripts.
keywords:
- NotifyScoped
- API
- NotifyScoped
- call(String notifyPhoneNumber
- String toPhoneNumber
- GlideRecord conferenceCall
- GlideRecord conferenceCallRecord
- String user... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyUtil/concept/NotifyUtilAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/NotifyUtil/concept/NotifyUtilAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/NotifyUtil/concept/NotifyUtilAPI.html | vancouver | NotifyUtil - Global | The NotifyUtil API provides utility methods to use when interacting with Notify calls and SMS messages using server-side scripts. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyUtil/concept/NotifyUtilAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/NotifyUtil/concept/NotifyUtilAPI.html"><div class="wm">The Vancouver release is no longer suppo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# NotifyUtil - Global
The NotifyUtil API provides utility methods to use when interacting
with Notify calls and SMS messages using server-side script... | ---
title: NotifyUtil - Global
description: The NotifyUtil API provides utility methods to use when interacting with
Notify calls and SMS messages using server-side scripts.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supp... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OAuthUtil/concept/c_OAuthUtilScriptInclude.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OAuthUtil/concept/c_OAuthUtilScriptInclude.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OAuthUtil/concept/c_OAuthUtilScriptInclude.html | vancouver | OAuthUtil - Global | This script include modifies request parameters and parses the token response during runtime. | [
"OAuth",
"OAuthUtil",
"OAuthUtil",
"interceptRequestParameters(requestParamMap)",
"parseTokenResponse(accessTokenResponse)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OAuthUtil/concept/c_OAuthUtilScriptInclude.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OAuthUtil/concept/c_OAuthUtilScriptInclude.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OAuthUtil - Global
This script include modifies request parameters and parses the token response during
runtime.
If the external OAuth provider re... | ---
title: OAuthUtil - Global
description: This script include modifies request parameters and parses the token
response during runtime.
keywords:
- OAuth
- OAuthUtil
- OAuthUtil
- interceptRequestParameters(requestParamMap)
- parseTokenResponse(accessTokenResponse)
breadcrumbs:
- API implementation and reference
- A... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRosterSpanApprovalUtil/concept/c_OCRosterSpanApprovalUtilAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRosterSpanApprovalUtil/concept/c_OCRosterSpanApprovalUtilAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCRosterSpanApprovalUtil/concept/c_OCRosterSpanApprovalUtilAPI.html | vancouver | OCRosterSpanApprovalUtil - Global | The OCRosterSpanApprovalUtil API provides methods for the PTO approval feature. | [
"OCRosterSpanApprovalUtil",
"approvePTOSpan (GlideRecord rosterSpanGr)",
"getContextualCalUrlPerSpanProposal (GlideRecord rosterSpanProposalGr)",
"getFromDateDisplayValuePerSpanProposal (GlideRecord rosterSpanProposalGr)",
"getPTOApproversList getPTOApproversList (GlideRecord rosterSpanProposalGr)",
"getT... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRosterSpanApprovalUtil/concept/c_OCRosterSpanApprovalUtilAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRosterSpanApprovalUtil/concept/c_OCRosterSpanApprovalUtilAPI.ht... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCRosterSpanApprovalUtil - Global
The OCRosterSpanApprovalUtil API provides methods for the PTO
approval feature.
## OCRosterSpanApprovalUtil - ap... | ---
title: OCRosterSpanApprovalUtil - Global
description: The OCRosterSpanApprovalUtil API provides methods for the PTO approval
feature.
keywords:
- OCRosterSpanApprovalUtil
- approvePTOSpan (GlideRecord rosterSpanGr)
- getContextualCalUrlPerSpanProposal (GlideRecord rosterSpanProposalGr)
- getFromDateDisplayValuePe... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotaICalendar/concept/c_OCRotaICalendarAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotaICalendar/concept/c_OCRotaICalendarAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCRotaICalendar/concept/c_OCRotaICalendarAPI.html | vancouver | OCRotaICalendar - Global | The OCRotaICalendar API is an extension of the OCRotaICalendarSNC API. | [
"OCRotaICalendar"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotaICalendar/concept/c_OCRotaICalendarAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotaICalendar/concept/c_OCRotaICalendarAPI.html"><div class="wm">The Vancouver re... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCRotaICalendar - Global
The OCRotaICalendar API is an extension of the OCRotaICalendarSNC API.
| ---
title: OCRotaICalendar - Global
description: The OCRotaICalendar API is an extension of the OCRotaICalendarSNC API.
keywords:
- OCRotaICalendar
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotaICalendarSNC/concept/c_OCRotaICalendarSNCAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotaICalendarSNC/concept/c_OCRotaICalendarSNCAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCRotaICalendarSNC/concept/c_OCRotaICalendarSNCAPI.html | vancouver | OCRotaICalendarSNC - Global | The OCRotaICalendarSNC API provides iCal formatted events for the a specific user's rotation. | [
"OCRotaICalendarSNC",
"cleanExpiredCache()",
"createCalendarEvents (String groupId",
"String rotaId",
"String userId",
"Object dateRangeObj)",
"createCustomEvent (String groupName",
"Object scheduleItemSpan",
"String calendarLink)",
"createPlaceholderCalendar (GlideRecord rotaGR",
"Object dateRa... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotaICalendarSNC/concept/c_OCRotaICalendarSNCAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotaICalendarSNC/concept/c_OCRotaICalendarSNCAPI.html"><div class="wm">The ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCRotaICalendarSNC - Global
The OCRotaICalendarSNC API provides iCal formatted events for the a specific user's
rotation.
## OCRotaICalendarSNC - ... | ---
title: OCRotaICalendarSNC - Global
description: The OCRotaICalendarSNC API provides iCal formatted events for the a specific
user's rotation.
keywords:
- OCRotaICalendarSNC
- cleanExpiredCache()
- createCalendarEvents (String groupId
- String rotaId
- String userId
- Object dateRangeObj)
- createCustomEvent (Stri... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotaMember/concept/c_OCRotaMemberAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotaMember/concept/c_OCRotaMemberAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCRotaMember/concept/c_OCRotaMemberAPI.html | vancouver | OCRotaMember - Global | The OCRotaMember API performs maintenance operations on the cmn_rota_member table. | [
"OCRotaMember",
"deactivateUser (String userId",
"GlideDateTime deactivateDate)",
"hasChanged (GlideRecord current",
"GlideRecord previous)",
"hasOrderChanged (GlideRecord current",
"GlideRecord previous)",
"recalculate (GlideRecord current",
"GlideRecord previous)",
"validateDates (String from",
... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotaMember/concept/c_OCRotaMemberAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotaMember/concept/c_OCRotaMemberAPI.html"><div class="wm">The Vancouver release is no ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCRotaMember - Global
The OCRotaMember API performs maintenance operations on the cmn\_rota\_member
table.
## OCRotaMember - deactivateUser (Strin... | ---
title: OCRotaMember - Global
description: The OCRotaMember API performs maintenance operations on the cmn_rota_member
table.
keywords:
- OCRotaMember
- deactivateUser (String userId
- GlideDateTime deactivateDate)
- hasChanged (GlideRecord current
- GlideRecord previous)
- hasOrderChanged (GlideRecord current
- G... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotation/Concept/c_OCRotation.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotation/Concept/c_OCRotation.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCRotation/Concept/c_OCRotation.html | vancouver | OCRotation - Global | The core OCRotation builds a data structure that is used to display the calendar. | [
"OCRotation",
"On-call rotation",
"Schedules",
"Rotas",
"Rosters",
"buildrotas",
"getEndDate()",
"getGroupIds()",
"getRosterIds()",
"getRotaGr(String rotaIds",
"String groupIds",
"String rosterIds",
"String userIds)",
"getRotaIds()",
"getStartDate()",
"getTimezone()",
"getUserIDs()",... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotation/Concept/c_OCRotation.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotation/Concept/c_OCRotation.html"><div class="wm">The Vancouver release is no longer support... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCRotation - Global
The core OCRotation builds a data structure that is used to display
the calendar.
The code builds up the GlideAJAXSchedulePage... | ---
title: OCRotation - Global
description: The core OCRotation builds a data structure that is used to display the
calendar.
keywords:
- OCRotation
- On-call rotation
- Schedules
- Rotas
- Rosters
- buildrotas
- getEndDate()
- getGroupIds()
- getRosterIds()
- getRotaGr(String rotaIds
- String groupIds
- String roste... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotationV2/Concept/c_OCRotationV2.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCRotationV2/Concept/c_OCRotationV2.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCRotationV2/Concept/c_OCRotationV2.html | vancouver | OCRotationV2 - Global | OCRotationV2 is an extension of OCRotation, which is used by Fullcalendar.io and the DHTMLX On-Call Calendar. | [
"OCRotationV2",
"On-call rotation",
"Schedules",
"Rotas",
"Rosters",
"OCRotation",
"DHTMLX",
"Fullcalendar",
"getGroups()",
"getRostersByRotas(String rotaSysIds)",
"getRotasByGroup(String groupSysIds)",
"getSpans()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotationV2/Concept/c_OCRotationV2.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCRotationV2/Concept/c_OCRotationV2.html"><div class="wm">The Vancouver release is no longer... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCRotationV2 - Global
OCRotationV2 is an extension of OCRotation, which
is used by Fullcalendar.io and the DHTMLX On-Call Calendar.
OCRotationV2 i... | ---
title: OCRotationV2 - Global
description: OCRotationV2 is an extension of OCRotation, which is used by Fullcalendar.io
and the DHTMLX On-Call Calendar.
keywords:
- OCRotationV2
- On-call rotation
- Schedules
- Rotas
- Rosters
- OCRotation
- DHTMLX
- Fullcalendar
- getGroups()
- getRostersByRotas(String rotaSysIds... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCSeriesEventGenerator/concept/c_OCSeriesEventGeneratorAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCSeriesEventGenerator/concept/c_OCSeriesEventGeneratorAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCSeriesEventGenerator/concept/c_OCSeriesEventGeneratorAPI.html | vancouver | OCSeriesEventGenerator - Global | The OCSeriesEventGenerator API generates the repeating VEVENTS for a user's iCalendar. | [
"OCSeriesEventGenerator",
"getMemberCalendar (String groupId",
"String rotaId",
"String userId",
"Object dateRangeObj",
"Object memberSchedules",
"String calendarLink)",
"getRosterICalEvents (GlideRecord rotaScheduleSpanGR",
"GlideRecord memberScheduleSpanGR",
"Array seriesStartTimes",
"Object e... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCSeriesEventGenerator/concept/c_OCSeriesEventGeneratorAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCSeriesEventGenerator/concept/c_OCSeriesEventGeneratorAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCSeriesEventGenerator - Global
The OCSeriesEventGenerator API generates the repeating VEVENTS for a user's
iCalendar.
## OCSeriesEventGenerator -... | ---
title: OCSeriesEventGenerator - Global
description: The OCSeriesEventGenerator API generates the repeating VEVENTS for a
user's iCalendar.
keywords:
- OCSeriesEventGenerator
- getMemberCalendar (String groupId
- String rotaId
- String userId
- Object dateRangeObj
- Object memberSchedules
- String calendarLink)
- ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCTimer/concept/c_OCTimerAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OCTimer/concept/c_OCTimerAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OCTimer/concept/c_OCTimerAPI.html | vancouver | OCTimer - Global | The OCTimer API provides the ability to track the length of time it takes for a function to complete. | [
"OCTimer",
"log (String name",
"String entry)",
"millisToTime (Integer millis)",
"result ()",
"start (String name)",
"stop (String name)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCTimer/concept/c_OCTimerAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OCTimer/concept/c_OCTimerAPI.html"><div class="wm">The Vancouver release is no longer supported. As... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OCTimer - Global
The OCTimer API provides the ability to track the length of time it takes for a
function to complete.
The OCTimer API requires th... | ---
title: OCTimer - Global
description: The OCTimer API provides the ability to track the length of time it takes
for a function to complete.
keywords:
- OCTimer
- log (String name
- String entry)
- millisToTime (Integer millis)
- result ()
- start (String name)
- stop (String name)
breadcrumbs:
- API implementation... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OnCallContactPreferenceUtil/concept/c_OnCallContactPreferenceUtilAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OnCallContactPreferenceUtil/concept/c_OnCallContactPreferenceUtilAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OnCallContactPreferenceUtil/concept/c_OnCallContactPreferenceUtilAPI.html | vancouver | OnCallContactPreferenceUtil - Global | Utility for handling contact preferences. | [
"OnCallContactPreferenceUtil API",
"OnCallContactPreferenceUtil",
"OnCallContactPreferenceUtil()",
"OnCallContactPreferenceUtil",
"getContactsAtByEscalatee()",
"OnCallContactPreferenceUtil",
"getUserPreferences()",
"getCatchAllContacts()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OnCallContactPreferenceUtil/concept/c_OnCallContactPreferenceUtilAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OnCallContactPreferenceUtil/concept/c_OnCallContactPreferen... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OnCallContactPreferenceUtil - Global
Utility for handling contact preferences.
For contact preference configuration, see Configure contact prefere... | ---
title: OnCallContactPreferenceUtil - Global
description: Utility for handling contact preferences.
keywords:
- OnCallContactPreferenceUtil API
- OnCallContactPreferenceUtil
- OnCallContactPreferenceUtil()
- OnCallContactPreferenceUtil
- getContactsAtByEscalatee()
- OnCallContactPreferenceUtil
- getUserPreferences()... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OnCallRotation/concept/c_OnCallRotationAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OnCallRotation/concept/c_OnCallRotationAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OnCallRotation/concept/c_OnCallRotationAPI.html | vancouver | OnCallRotation - Global | Use to manage on-call schedules. | [
"OnCallRotation API",
"OnCallRotation",
"getCatchAll(String rotaID)",
"getCatchAllType(String rotaID)",
"OnCallRotation",
"getEscalatees()",
"getEscalateeAt(String groupID",
"GlideDateTime dateTime",
"Number position)",
"getEscalationPlan()",
"getEscalationType(String rotaID)",
"OnCallRotation... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OnCallRotation/concept/c_OnCallRotationAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OnCallRotation/concept/c_OnCallRotationAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OnCallRotation - Global
Use to manage on-call schedules.
For information, see On-call scheduling
## OnCallRotation - getCatchAll(String rotaID)
... | ---
title: OnCallRotation - Global
description: Use to manage on-call schedules.
keywords:
- OnCallRotation API
- OnCallRotation
- getCatchAll(String rotaID)
- getCatchAllType(String rotaID)
- OnCallRotation
- getEscalatees()
- getEscalateeAt(String groupID
- GlideDateTime dateTime
- Number position)
- getEscalationPla... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Optional/concept/OptionalGlobalAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Optional/concept/OptionalGlobalAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Optional/concept/OptionalGlobalAPI.html | vancouver | Optional - Scoped, Global | The Optional API interacts with a single record returned by the GlideQuery, Stream, or GlideRecord APIs, even when it does not exist. Write scripts that are less likely to result in an error by handling null or undefined query results. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Optional/concept/OptionalGlobalAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Optional/concept/OptionalGlobalAPI.html"><div class="wm">The Vancouver release is no longer s... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Optional - Scoped, Global
The Optional API interacts with a single record returned by the
GlideQuery, Stream, or GlideRecord
APIs, even when it doe... | ---
title: Optional - Scoped, Global
description: The Optional API interacts with a single record returned by the GlideQuery,
Stream, or GlideRecord APIs, even when it does not exist. Write scripts that are
less likely to result in an error by handling null or undefined query results.
keywords: []
breadcrumbs:
- AP... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OrderGuideScoped/concept/OrderGuideScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/OrderGuideScoped/concept/OrderGuideScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/OrderGuideScoped/concept/OrderGuideScopedAPI.html | vancouver | OrderGuide - Scoped | The OrderGuide API enables you to initialize and view order guide details. | [
"Scoped OrderGuide",
"OrderGuide",
"OrderGuide(String sys_id)",
"getID()",
"init(Map request)",
"OrderGuideJS",
"isIncludeItems()",
"isTwoStep()",
"isUseCustomCart()",
"navigateFromMap(Map itemDetails)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OrderGuideScoped/concept/OrderGuideScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/OrderGuideScoped/concept/OrderGuideScopedAPI.html"><div class="wm">The Vancouver re... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OrderGuide - Scoped
The OrderGuide API enables you to initialize and view order guide
details.
To use this class in a scoped application, use the ... | ---
title: OrderGuide - Scoped
description: The OrderGuide API enables you to initialize and view order guide details.
keywords:
- Scoped OrderGuide
- OrderGuide
- OrderGuide(String sys_id)
- getID()
- init(Map request)
- OrderGuideJS
- isIncludeItems()
- isTwoStep()
- isUseCustomCart()
- navigateFromMap(Map itemDetail... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PADomainUtils/concept/c_PADomainUtils.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PADomainUtils/concept/c_PADomainUtils.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PADomainUtils/concept/c_PADomainUtils.html | vancouver | PADomainUtils - Global | The PADomainUtils API enables you to copy Performance Analytics records between different domains on the same instance. | [
"PADomainUtils",
"copy(String runAs)",
"copyDashboard(String dashboardId",
"String runAs)",
"copyJob(String paJob",
"String runAs)",
"isWriteable(String table",
"String id)",
"move(String runAs)",
"PADomainUtils()",
"PADomainUtils(String domainFrom)",
"setFoundation(boolean foundation)",
"se... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PADomainUtils/concept/c_PADomainUtils.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PADomainUtils/concept/c_PADomainUtils.html"><div class="wm">The Vancouver release is no lo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PADomainUtils - Global
The PADomainUtils API enables you to copy Performance Analytics records
between different domains on the same instance.
Use... | ---
title: PADomainUtils - Global
description: The PADomainUtils API enables you to copy Performance Analytics records
between different domains on the same instance.
keywords:
- PADomainUtils
- copy(String runAs)
- copyDashboard(String dashboardId
- String runAs)
- copyJob(String paJob
- String runAs)
- isWriteable(... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PAScorecard/concept/PAScorecard.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PAScorecard/concept/PAScorecard.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PAScorecard/concept/PAScorecard.html | vancouver | PAScorecard - Scoped | The PAScorecard API enables you to fetch data about indicators and their associated records, such as breakdowns. | [
"PAScorecard",
"addParam(String parameter",
"String value)",
"query()",
"result()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PAScorecard/concept/PAScorecard.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PAScorecard/concept/PAScorecard.html"><div class="wm">The Vancouver release is no longer support... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PAScorecard - Scoped
The PAScorecard API enables you to fetch data about indicators and
their associated records, such as breakdowns.
This API req... | ---
title: PAScorecard - Scoped
description: The PAScorecard API enables you to fetch data about indicators and their
associated records, such as breakdowns.
keywords:
- PAScorecard
- addParam(String parameter
- String value)
- query()
- result()
breadcrumbs:
- API implementation and reference
- API reference
- Serve... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PASnapshot/concept/PASnapshot.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PASnapshot/concept/PASnapshot.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PASnapshot/concept/PASnapshot.html | vancouver | PASnapshot - Scoped | The PASnapshot API enables you to query information about Performance Analytics snapshots. Snapshots are the lists of records (sys_ids) that are collected at the time that the scores for those records are collected. A snapshot is made only for automated | [
"PASnapshot",
"getCompareIDs(String sys_id",
"Number date1",
"Number date2",
"String type)",
"getCompareQuery(String sys_id",
"number date1",
"number date2",
"String type)",
"getIDs(String sys_id",
"Number date)",
"getQuery(String sys_id",
"number date)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PASnapshot/concept/PASnapshot.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PASnapshot/concept/PASnapshot.html"><div class="wm">The Vancouver release is no longer supported. ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PASnapshot - Scoped
The PASnapshot API enables you to query information about Performance Analytics snapshots. Snapshots are the lists of records (... | ---
title: PASnapshot - Scoped
description: The PASnapshot API enables you to query information about Performance
Analytics snapshots. Snapshots are the lists of records (sys_ids) that are collected
at the time that the scores for those records are collected. A snapshot is made
only for automated
keywords:
- PASn... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PDAutomationProviderBoth/concept/PDAutomationProviderBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PDAutomationProviderBoth/concept/PDAutomationProviderBothAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PDAutomationProviderBoth/concept/PDAutomationProviderBothAPI.html | vancouver | PDAutomationProvider - Scoped, Global | The PDAutomationProvider API enables inserting an optional activity into a process while it's executing. | [
"Optional Activities API"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PDAutomationProviderBoth/concept/PDAutomationProviderBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PDAutomationProviderBoth/concept/PDAutomationProviderBothAPI.html">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PDAutomationProvider - Scoped, Global
The PDAutomationProvider API enables inserting an optional activity
into a process while it's executing.
Thi... | ---
title: PDAutomationProvider - Scoped, Global
description: The PDAutomationProvider API enables inserting an optional activity into
a process while it's executing.
keywords:
- Optional Activities API
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release i... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PDFGenerationAPIBoth/concept/PDFGenerationAPIBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PDFGenerationAPIBoth/concept/PDFGenerationAPIBothAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PDFGenerationAPIBoth/concept/PDFGenerationAPIBothAPI.html | vancouver | PDFGenerationAPI - Scoped, Global | The PDFGenerationAPI provides support for PDF conversion and handling PDF fields. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PDFGenerationAPIBoth/concept/PDFGenerationAPIBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PDFGenerationAPIBoth/concept/PDFGenerationAPIBothAPI.html"><div class="wm">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PDFGenerationAPI - Scoped, Global
The PDFGenerationAPI provides support for PDF conversion and
handling PDF fields.
This API is part of the Servic... | ---
title: PDFGenerationAPI - Scoped, Global
description: The PDFGenerationAPI provides support for PDF conversion and handling
PDF fields.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product docume... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ParagraphBoth/concept/ParagraphBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ParagraphBoth/concept/ParagraphBothAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ParagraphBoth/concept/ParagraphBothAPI.html | vancouver | Paragraph - Scoped, Global | Creates a Paragraph object representing a block of text in a PDF. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ParagraphBoth/concept/ParagraphBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ParagraphBoth/concept/ParagraphBothAPI.html"><div class="wm">The Vancouver release is no ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Paragraph - Scoped, Global
Creates a Paragraph object representing a
block of text in a PDF.
This API is part of the ServiceNow PDF
Generation Uti... | ---
title: Paragraph - Scoped, Global
description: Creates a Paragraph object representing a block of text in a PDF.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release notes... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PdfMergeSignRequestorBoth/concept/PdfMergeSignRequestorBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PdfMergeSignRequestorBoth/concept/PdfMergeSignRequestorBothAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PdfMergeSignRequestorBoth/concept/PdfMergeSignRequestorBothAPI.html | vancouver | PdfMergeSignRequestor - Scoped, Global | The PdfMergeSignRequestor API adds an image representing a signature to a PDF document. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PdfMergeSignRequestorBoth/concept/PdfMergeSignRequestorBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PdfMergeSignRequestorBoth/concept/PdfMergeSignRequestorBothAPI.ht... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PdfMergeSignRequestor - Scoped, Global
The PdfMergeSignRequestor API adds an image representing a signature
to a PDF document.
This API is part of... | ---
title: PdfMergeSignRequestor - Scoped, Global
description: The PdfMergeSignRequestor API adds an image representing a signature
to a PDF document.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the pro... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PdfPageBoth/concept/PdfPageBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PdfPageBoth/concept/PdfPageBothAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PdfPageBoth/concept/PdfPageBothAPI.html | vancouver | PdfPage - Scoped, Global | Creates a PdfPage object representing a PDF page and its attributes; such as size, width, and color. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PdfPageBoth/concept/PdfPageBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PdfPageBoth/concept/PdfPageBothAPI.html"><div class="wm">The Vancouver release is no longer s... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PdfPage - Scoped, Global
Creates a PdfPage object representing a PDF
page and its attributes; such as size, width, and color.
This API is part of ... | ---
title: PdfPage - Scoped, Global
description: Creates a PdfPage object representing a PDF page and its attributes;
such as size, width, and color.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the prod... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PlaybookExperienceScoped/concept/PlaybookExperienceScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PlaybookExperienceScoped/concept/PlaybookExperienceScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PlaybookExperienceScoped/concept/PlaybookExperienceScopedAPI.html | vancouver | PlaybookExperience - Scoped | The PlaybookExperience API provides methods for handling playbook executions. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PlaybookExperienceScoped/concept/PlaybookExperienceScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PlaybookExperienceScoped/concept/PlaybookExperienceScopedAPI.html">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PlaybookExperience - Scoped
The PlaybookExperience API provides methods for handling playbook
executions.
This API requires the Playbook Experienc... | ---
title: PlaybookExperience - Scoped
description: The PlaybookExperience API provides methods for handling playbook executions.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PolarisUIScoped/concept/PolarisUIScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PolarisUIScoped/concept/PolarisUIScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PolarisUIScoped/concept/PolarisUIScopedAPI.html | vancouver | PolarisUI - Scoped | The PolarisUI API provides methods for enabling Next Experience on direct UI pages. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PolarisUIScoped/concept/PolarisUIScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PolarisUIScoped/concept/PolarisUIScopedAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PolarisUI - Scoped
The PolarisUI API provides methods for enabling Next Experience on direct UI pages.
A UI page [sys\_ui\_page] is direct if the ... | ---
title: PolarisUI - Scoped
description: The PolarisUI API provides methods for enabling Next Experience on direct
UI pages.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and r... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PredictabilityEstimate/concept/PredictabilityEstimateAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PredictabilityEstimate/concept/PredictabilityEstimateAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PredictabilityEstimate/concept/PredictabilityEstimateAPI.html | vancouver | PredictabilityEstimate - Global | The PredictabilityEstimate API is a scriptable object used in Predictive Intelligence stores. This object provides estimation of how predictable fields of a dataset can be, and which features can be useful for predicting those fields. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PredictabilityEstimate/concept/PredictabilityEstimateAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PredictabilityEstimate/concept/PredictabilityEstimateAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PredictabilityEstimate - Global
The PredictabilityEstimate API is a scriptable object used in Predictive Intelligence stores. This object provides ... | ---
title: PredictabilityEstimate - Global
description: The PredictabilityEstimate API is a scriptable object used in Predictive
Intelligence stores. This object provides estimation of how predictable fields of
a dataset can be, and which features can be useful for predicting those fields.
keywords: []
breadcrumbs:... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PredictabilityEstimateStore/concept/PredictabilityEstimateStoreAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PredictabilityEstimateStore/concept/PredictabilityEstimateStoreAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PredictabilityEstimateStore/concept/PredictabilityEstimateStoreAPI.html | vancouver | PredictabilityEstimateStore - Global | Enables storing and retrieving predictability estimates. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PredictabilityEstimateStore/concept/PredictabilityEstimateStoreAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PredictabilityEstimateStore/concept/PredictabilityEstimateSto... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PredictabilityEstimateStore - Global
Enables storing
and retrieving predictability estimates.
The PredictabilityEstimateStore
API requires the Pr... | ---
title: PredictabilityEstimateStore - Global
description: Enables storing and retrieving predictability estimates.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release note... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PredictabilityEstimateVersion/concept/PredictabilityEstimateVersionAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PredictabilityEstimateVersion/concept/PredictabilityEstimateVersionAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PredictabilityEstimateVersion/concept/PredictabilityEstimateVersionAPI.html | vancouver | PredictabilityEstimateVersion - Global | The PredictabilityEstimateVersion API is a scriptable object used in Predictive Intelligence stores. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PredictabilityEstimateVersion/concept/PredictabilityEstimateVersionAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PredictabilityEstimateVersion/concept/PredictabilityEstim... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PredictabilityEstimateVersion - Global
The PredictabilityEstimateVersion API is a scriptable object used in
Predictive Intelligence stores.
This ... | ---
title: PredictabilityEstimateVersion - Global
description: The PredictabilityEstimateVersion API is a scriptable object used in
Predictive Intelligence stores.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PreferenceDestination/concept/PreferenceDestinationBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/PreferenceDestination/concept/PreferenceDestinationBothAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/PreferenceDestination/concept/PreferenceDestinationBothAPI.html | vancouver | PreferenceDestination - Scoped, Global | The PreferenceDestination API updates user notification preferences. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PreferenceDestination/concept/PreferenceDestinationBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/PreferenceDestination/concept/PreferenceDestinationBothAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# PreferenceDestination - Scoped, Global
The PreferenceDestination API updates user notification
preferences.
A notification destination is somewher... | ---
title: PreferenceDestination - Scoped, Global
description: The PreferenceDestination API updates user notification preferences.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation an... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Preferences/concept/PreferencesBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Preferences/concept/PreferencesBothAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Preferences/concept/PreferencesBothAPI.html | vancouver | Preferences - Scoped, Global | The Preferences API gets notification destinations for a user. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Preferences/concept/PreferencesBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Preferences/concept/PreferencesBothAPI.html"><div class="wm">The Vancouver release is no ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Preferences - Scoped, Global
The Preferences API gets notification destinations for a
user.
A notification destination is somewhere that a notific... | ---
title: Preferences - Scoped, Global
description: The Preferences API gets notification destinations for a user.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release notes ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProactiveTriggerAPI/concept/ProactiveTriggerScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProactiveTriggerAPI/concept/ProactiveTriggerScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ProactiveTriggerAPI/concept/ProactiveTriggerScopedAPI.html | vancouver | ProactiveTriggerAPI - Scoped | The ProactiveTriggerAPI enables you to create server-side triggers that send context-specific messages to a specified user. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProactiveTriggerAPI/concept/ProactiveTriggerScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProactiveTriggerAPI/concept/ProactiveTriggerScopedAPI.html"><div class="wm... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ProactiveTriggerAPI - Scoped
The ProactiveTriggerAPI enables you to create server-side triggers that send context-specific messages to a specified ... | ---
title: ProactiveTriggerAPI - Scoped
description: The ProactiveTriggerAPI enables you to create server-side triggers that
send context-specific messages to a specified user.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer s... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerCim/concept/c_ProbeHandlerCimAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerCim/concept/c_ProbeHandlerCimAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ProbeHandlerCim/concept/c_ProbeHandlerCimAPI.html | vancouver | ProbeHandlerCim - Global | The ProbeHandlerCim API provides methods to configures a CIM probe. | [
"ProbeHandlerCim API",
"ProbeHandlerCim",
"getCimQueries()",
"getNamespace()",
"getParameters()",
"setProbeParameters(Object params)",
"run()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerCim/concept/c_ProbeHandlerCimAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerCim/concept/c_ProbeHandlerCimAPI.html"><div class="wm">The Vancouver re... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ProbeHandlerCim - Global
The ProbeHandlerCim API provides methods to configures a CIM
probe.
Use in any server-side script where you need to confi... | ---
title: ProbeHandlerCim - Global
description: The ProbeHandlerCim API provides methods to configures a CIM probe.
keywords:
- ProbeHandlerCim API
- ProbeHandlerCim
- getCimQueries()
- getNamespace()
- getParameters()
- setProbeParameters(Object params)
- run()
breadcrumbs:
- API implementation and reference
- API re... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerMulti/concept/c_ProbeHandlerMultiAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerMulti/concept/c_ProbeHandlerMultiAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ProbeHandlerMulti/concept/c_ProbeHandlerMultiAPI.html | vancouver | ProbeHandlerMulti - Global | The ProbeHandlerMulti API is a probe handler for MultiProbes. | [
"ProbeHandlerMulti API",
"ProbeHandlerMulti",
"addParameters(String parent",
"String sysID",
"GlideRecord probe)",
"addProbes(String parent",
"String sysID)",
"run()",
"runProbeHandler(String params",
"String sysID",
"GlideRecord probe)",
"setParameter(String parent",
"String name",
"Strin... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerMulti/concept/c_ProbeHandlerMultiAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerMulti/concept/c_ProbeHandlerMultiAPI.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ProbeHandlerMulti - Global
The ProbeHandlerMulti API is a probe handler for
MultiProbes.
This script include does not work with probe parameters t... | ---
title: ProbeHandlerMulti - Global
description: The ProbeHandlerMulti API is a probe handler for MultiProbes.
keywords:
- ProbeHandlerMulti API
- ProbeHandlerMulti
- addParameters(String parent
- String sysID
- GlideRecord probe)
- addProbes(String parent
- String sysID)
- run()
- runProbeHandler(String params
- Str... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerSNMP/concept/c_ProbeHandlerSNMPAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerSNMP/concept/c_ProbeHandlerSNMPAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ProbeHandlerSNMP/concept/c_ProbeHandlerSNMPAPI.html | vancouver | ProbeHandlerSNMP - Global | The ProbeHandlerSNMP API is a discovery probe handler for SNMP probes, invoked when an SNMP probe is about to be created. | [
"ProbeHandlerSNMP API",
"ProbeHandlerSNMP",
"addBoolean(String dbName",
"String paramName",
"String paramMap)",
"addDebug(String paramMap)",
"addJavascriptHandlers(String paramMap)",
"addOIDAutoResolve(String paramMap)",
"addOIDSpec(String paramMap)",
"addSensorHandler(String paramMap)",
"addSta... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerSNMP/concept/c_ProbeHandlerSNMPAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerSNMP/concept/c_ProbeHandlerSNMPAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ProbeHandlerSNMP - Global
The ProbeHandlerSNMP API is a discovery probe handler for SNMP
probes, invoked when an SNMP probe is about to be created.... | ---
title: ProbeHandlerSNMP - Global
description: The ProbeHandlerSNMP API is a discovery probe handler for SNMP probes,
invoked when an SNMP probe is about to be created.
keywords:
- ProbeHandlerSNMP API
- ProbeHandlerSNMP
- addBoolean(String dbName
- String paramName
- String paramMap)
- addDebug(String paramMap)
-... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerWMI/concept/c_ProbeHandlerWMIAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProbeHandlerWMI/concept/c_ProbeHandlerWMIAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ProbeHandlerWMI/concept/c_ProbeHandlerWMIAPI.html | vancouver | ProbeHandlerWMI - Global | The ProbeHandlerWMI API is the discovery probe handler for Windows Management Instrumentation (WMI) probes. | [
"ProbeHandlerWMI API",
"ProbeHandlerWMI",
"getParameters()",
"getWMIFields()",
"run()",
"setProbeParameters(Object params)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerWMI/concept/c_ProbeHandlerWMIAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProbeHandlerWMI/concept/c_ProbeHandlerWMIAPI.html"><div class="wm">The Vancouver re... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ProbeHandlerWMI - Global
The ProbeHandlerWMI API is the discovery probe handler for Windows
Management Instrumentation (WMI) probes.
Use in any se... | ---
title: ProbeHandlerWMI - Global
description: The ProbeHandlerWMI API is the discovery probe handler for Windows Management
Instrumentation (WMI) probes.
keywords:
- ProbeHandlerWMI API
- ProbeHandlerWMI
- getParameters()
- getWMIFields()
- run()
- setProbeParameters(Object params)
breadcrumbs:
- API implementatio... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Producer/concept/ProducerScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Producer/concept/ProducerScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Producer/concept/ProducerScopedAPI.html | vancouver | Producer - Scoped (deprecated) | The Producer API provides methods that enable you to push data from a ServiceNow instance to a Kafka topic. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Producer/concept/ProducerScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Producer/concept/ProducerScopedAPI.html"><div class="wm">The Vancouver release is no longer s... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Producer - Scoped (deprecated)
The Producer API provides methods that enable you to push data from
a ServiceNow instance to a Kafka topic.
Note: T... | ---
title: Producer - Scoped (deprecated)
description: The Producer API provides methods that enable you to push data from a
ServiceNow instance to a Kafka topic.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As s... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProducerV2/concept/ProducerV2ScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ProducerV2/concept/ProducerV2ScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ProducerV2/concept/ProducerV2ScopedAPI.html | vancouver | ProducerV2 - Scoped | The ProducerV2 API provides methods to publish messages from your ServiceNow instance to a Kafka topic. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProducerV2/concept/ProducerV2ScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ProducerV2/concept/ProducerV2ScopedAPI.html"><div class="wm">The Vancouver release is no ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ProducerV2 - Scoped
The ProducerV2 API provides methods to publish messages from your
ServiceNow instance to a Kafka topic.
Note: This API require... | ---
title: ProducerV2 - Scoped
description: The ProducerV2 API provides methods to publish messages from your ServiceNow
instance to a Kafka topic.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the produc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Queue/concept/QueueScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Queue/concept/QueueScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Queue/concept/QueueScopedAPI.html | vancouver | Queue - Scoped | The Queue API allows you to retrieve or join a Connect Support chat queue. | [
"Queue",
"Scoped Queue",
"queue",
"get(sys_id)",
"Queue",
"join(String)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Queue/concept/QueueScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Queue/concept/QueueScopedAPI.html"><div class="wm">The Vancouver release is no longer supported. As... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Queue - Scoped
The Queue API allows you to retrieve or join a Connect Support chat queue.
To execute this class in a scoped application, use the `... | ---
title: Queue - Scoped
description: The Queue API allows you to retrieve or join a Connect Support chat queue.
keywords:
- Queue
- Scoped Queue
- queue
- get(sys_id)
- Queue
- join(String)
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer s... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Queue_global/concept/c_QueueAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Queue_global/concept/c_QueueAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Queue_global/concept/c_QueueAPI.html | vancouver | Queue - Global | The Queue API (Advanced Work Assignment) provides methods to route a document to a queue. | [
"Queue",
"Advanced Work Assignment (AWA)",
"routing"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Queue_global/concept/c_QueueAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Queue_global/concept/c_QueueAPI.html"><div class="wm">The Vancouver release is no longer support... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Queue - Global
The Queue API (Advanced Work Assignment) provides methods
to route a document to a queue.
This API is provided within the `sn_awa` ... | ---
title: Queue - Global
description: The Queue API (Advanced Work Assignment) provides methods to route a
document to a queue.
keywords:
- Queue
- Advanced Work Assignment (AWA)
- routing
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer s... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/QuickRanges/concept/c_QuickRangesAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/QuickRanges/concept/c_QuickRangesAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/QuickRanges/concept/c_QuickRangesAPI.html | vancouver | QuickRanges - Global | The QuickRanges API generates IP network, range, and address entries from a convenient comma-separated input field using conventional CIDR network notation, hyphenated range entries, or individual IP addresses. | [
"QuickRanges API",
"QuickRanges",
"createItem(String table",
"String id",
"String type)",
"onMakeRanges()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/QuickRanges/concept/c_QuickRangesAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/QuickRanges/concept/c_QuickRangesAPI.html"><div class="wm">The Vancouver release is no long... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# QuickRanges - Global
The QuickRanges API generates IP network, range, and address entries
from a convenient comma-separated input field using conve... | ---
title: QuickRanges - Global
description: The QuickRanges API generates IP network, range, and address entries
from a convenient comma-separated input field using conventional CIDR network notation,
hyphenated range entries, or individual IP addresses.
keywords:
- QuickRanges API
- QuickRanges
- createItem(Strin... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html | vancouver | RESTMessageV2 - Scoped, Global | The RESTMessageV2 API allows you to send outbound REST messages using JavaScript. | [
"RESTMessageV2",
"disableForcedVariableSubstitution()",
"RESTMessagev2",
"execute()",
"getEndpoint()",
"getRequestBody()",
"getRequestHeader(String headerName)",
"getRequestHeaders()",
"RESTMessageV2()",
"RESTMessageV2(String name",
"String methodName)",
"saveResponseBodyAsAttachment(String ta... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/concept/c_RESTMessageV2API.html"><div class="wm">The Vancouver release is... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RESTMessageV2 - Scoped, Global
The RESTMessageV2 API allows you to send outbound REST messages using
JavaScript.
Use the RESTResponseV2 API to man... | ---
title: RESTMessageV2 - Scoped, Global
description: The RESTMessageV2 API allows you to send outbound REST messages using
JavaScript.
keywords:
- RESTMessageV2
- disableForcedVariableSubstitution()
- RESTMessagev2
- execute()
- getEndpoint()
- getRequestBody()
- getRequestHeader(String headerName)
- getRequestHead... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html | vancouver | Direct RESTMessageV2 example | You can send an outbound REST message directly to the endpoint. | [
"RESTMessageV2",
"Example direct message"
] | [
"API implementation and reference",
"API implementation",
"Web services",
"Outbound web services",
"Outbound REST web service",
"Scripting outbound REST"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_DirectRESTMessageV2Example.html"><div class="wm">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Direct RESTMessageV2 example
You can send an outbound REST message directly to the endpoint.
In this example, the script sends a REST message requ... | ---
title: Direct RESTMessageV2 example
description: You can send an outbound REST message directly to the endpoint.
keywords:
- RESTMessageV2
- Example direct message
breadcrumbs:
- API implementation and reference
- API implementation
- Web services
- Outbound web services
- Outbound REST web service
- Scripting outb... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html | vancouver | RESTMessageV2 MID server example | You can send an outbound REST message through a MID Server. | [
"RESTMessageV2",
"Example with MID server"
] | [
"API implementation and reference",
"API implementation",
"Web services",
"Outbound web services",
"Outbound REST web service",
"Scripting outbound REST"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RESTMessageV2MIDServerExample.html"><div class... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RESTMessageV2 MID server example
You can send an outbound REST message through a MID Server.
By sending the message through a MID Server, you can ... | ---
title: RESTMessageV2 MID server example
description: You can send an outbound REST message through a MID Server.
keywords:
- RESTMessageV2
- Example with MID server
breadcrumbs:
- API implementation and reference
- API implementation
- Web services
- Outbound web services
- Outbound REST web service
- Scripting out... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html | vancouver | Recordless RESTMessageV2 example | You can use the RESTMessageV2() constructor with no parameters to define a REST message entirely in the script. | [
"RESTMessageV2",
"Example empty message"
] | [
"API implementation and reference",
"API implementation",
"Web services",
"Outbound web services",
"Outbound REST web service",
"Scripting outbound REST"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTMessageV2/reference/r_RecordlessRESTMessageV2Example.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Recordless RESTMessageV2 example
You can use the RESTMessageV2() constructor with no parameters to define a REST message
entirely in the script.
W... | ---
title: Recordless RESTMessageV2 example
description: You can use the RESTMessageV2() constructor with no parameters to define
a REST message entirely in the script.
keywords:
- RESTMessageV2
- Example empty message
breadcrumbs:
- API implementation and reference
- API implementation
- Web services
- Outbound web ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html | vancouver | RESTResponseV2 - Scoped, Global | The RESTResponseV2 API allows you to use the data returned by an outbound REST message in JavaScript code. | [
"RESTResponseV2",
"RESTResponseV2",
"getAllHeaders()",
"getBody()",
"getCookies()",
"getErrorCode()",
"getHeader(String name)",
"getHeaders()",
"getQueryString()",
"getResponseAttachmentSysid()",
"getStatusCode()",
"haveError()",
"waitForResponse(Number timeoutSecs)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RESTResponseV2/concept/c_RESTResponseV2API.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RESTResponseV2 - Scoped, Global
The RESTResponseV2 API allows you to use the data returned by an
outbound REST message in JavaScript code.
A RESTR... | ---
title: RESTResponseV2 - Scoped, Global
description: The RESTResponseV2 API allows you to use the data returned by an outbound
REST message in JavaScript code.
keywords:
- RESTResponseV2
- RESTResponseV2
- getAllHeaders()
- getBody()
- getCookies()
- getErrorCode()
- getHeader(String name)
- getHeaders()
- getQuer... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html | vancouver | RTETransformer - Scoped | The RTETransformer API provides a method to transform and store an array of messages into a record in the associated ServiceNow instance based on a provided extract, transform, and load (ETL) definition. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RTETransformer/concept/RTETransScopedAPI.html"><div class="wm">The Vancouver release is... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RTETransformer - Scoped
The RTETransformer API provides a method to transform and store an
array of messages into a record in the associated Servic... | ---
title: RTETransformer - Scoped
description: The RTETransformer API provides a method to transform and store an array
of messages into a record in the associated ServiceNow instance based on a provided
extract, transform, and load (ETL) definition.
keywords: []
breadcrumbs:
- API implementation and reference
- A... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html | vancouver | RecordToHTML - Global | The RecordToHTML API is a utility class to turn a record into HTML. | [
"RecordToHTML API",
"RecordToHTML",
"RecordToHTML(String table",
"String sys_id",
"String pattern",
"Boolean link)",
"setValue(String fieldName",
"String value)",
"toString()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RecordToHTML/concept/c_RecordToHTMLAPI.html"><div class="wm">The Vancouver release is no ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RecordToHTML - Global
The RecordToHTML API is a utility class to turn a record into
HTML.
This API is available to server-side scripts.
## Record... | ---
title: RecordToHTML - Global
description: The RecordToHTML API is a utility class to turn a record into HTML.
keywords:
- RecordToHTML API
- RecordToHTML
- RecordToHTML(String table
- String sys_id
- String pattern
- Boolean link)
- setValue(String fieldName
- String value)
- toString()
breadcrumbs:
- API implement... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html | vancouver | RegressionSolution - Global | The RegressionSolution API is a scriptable object used in Predictive Intelligence stores. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolution/concept/RegressionSolutionAPI.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RegressionSolution - Global
The RegressionSolution API is a scriptable object used in Predictive Intelligence stores.
This API requires the Predi... | ---
title: RegressionSolution - Global
description: The RegressionSolution API is a scriptable object used in Predictive
Intelligence stores.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product docu... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html | vancouver | RegressionSolutionStore - Global | Enables storing and retrieving solutions. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionStore/concept/RegressionSolutionStoreAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RegressionSolutionStore - Global
Enables storing
and retrieving solutions.
The RegressionSolutionStore
API requires the Predictive Intelligence p... | ---
title: RegressionSolutionStore - Global
description: Enables storing and retrieving solutions.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html | vancouver | RegressionSolutionVersion - Global | The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RegressionSolutionVersion/concept/RegressionSolutionVersionAPI.ht... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RegressionSolutionVersion - Global
The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.
This API requ... | ---
title: RegressionSolutionVersion - Global
description: The RegressionSolutionVersion API is a scriptable object used in Predictive
Intelligence stores.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, th... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html | vancouver | RemedialActionEngine - Scoped | The RemedialActionEngine API provides common methods for working with Remedial Actions. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RemedialAction/concept/RemedialActionScopedAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RemedialActionEngine - Scoped
The RemedialActionEngine API provides common methods for working with Remedial Actions.
This API is part of the Reme... | ---
title: RemedialActionEngine - Scoped
description: The RemedialActionEngine API provides common methods for working with
Remedial Actions.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product docu... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html | vancouver | RenderProperties - Global | The RenderProperties API provides methods about the current page and is available in Jelly scripts and in UI-action conditions and scripts. | [
"RenderProperites",
"RenderProperties",
"getEncodedQuery()",
"getListControl()",
"getParameterValue(String parameterName)",
"getReferringURL()",
"getViewID()",
"getViewName()",
"getWindowProperties()",
"isInDevStudio()",
"isInteractive()",
"isManyToMany()",
"isRelatedList()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderProperties/concept/RenderProperties-API.html"><div class="wm">The Vancouver ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RenderProperties - Global
The RenderProperties API provides methods about the current page and
is available in Jelly scripts and in UI-action condi... | ---
title: RenderProperties - Global
description: The RenderProperties API provides methods about the current page and
is available in Jelly scripts and in UI-action conditions and scripts.
keywords:
- RenderProperites
- RenderProperties
- getEncodedQuery()
- getListControl()
- getParameterValue(String parameterName)... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html | 2025-05-06 | daily | 0.5 | 4.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html | vancouver | RenderProperties - Scoped | The RenderProperties API provides methods about the current page and is available in Jelly scripts and in UI-action conditions and scripts. | [
"Scoped RenderProperties",
"Scoped ScopedRenderProperties",
"getEncodedQuery()",
"getListControl()",
"getParameterValue(String parameterName)",
"getReferringURL()",
"getViewName()",
"getWindowProperties()",
"isInDevStudio()",
"isInteractive()",
"isManyToMany()",
"isRelatedList()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/RenderPropertiesScoped/concept/RenderProperties-Scoped-API.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# RenderProperties - Scoped
The RenderProperties API provides methods about the current page and
is available in Jelly scripts and in UI-action condi... | ---
title: RenderProperties - Scoped
description: The RenderProperties API provides methods about the current page and
is available in Jelly scripts and in UI-action conditions and scripts.
keywords:
- Scoped RenderProperties
- Scoped ScopedRenderProperties
- getEncodedQuery()
- getListControl()
- getParameterValue(S... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.