Home New York Now Platform Capabilities Now Platform capabilities Service Portal Service Portal widgets Widget developer guide Widget API reference

Widget API reference

Service Portal includes client and server side APIs to use in widget client and server scripts.

Service Portal client-side APIs

These are Service Portal APIs that you can use in a widget client controller.

See the API reference for detailed class and method information.


Class	Description
spAriaUtil	Show messages on a screen reader.
spContextManager	Make data from a Service Portal widget available to other applications and services in a Service Portal page. For example, pass widget data to Agent Chat when it opens in a Service Portal page.
spUtil	Utility methods to perform common functions in a Service Portal widget client script.
spModal	Show alerts, prompts, and confirmation dialogs in Service Portal widgets. The SPModal class is available in Service Portal client scripts.

Note: g_form as a global object cannot be used in a widget client controller or in a UI script.

Service Portal server-side APIs

These are Service Portal APIs that you can use in a widget server script.


Class	Description
GlideSPScriptable	Interact with data and perform record operations in Service Portal widgets.
GlideSPSearchAnalytics	Generate search analytics from custom Service Portal search widgets.
spScriptedFacet	Define facet items, filters, or mapped queries for a facets object.
spScriptedFacetService	Generate a multi choice or single choice facets object for an advanced search source.

Global variable and functions available in widget client and server scripts.

Server script global objects


Property	Description
`input`	An object containing client-side properties set under `c.data`. The value is `undefined` until the client controller calls `c.server.update()`.
`data`	An object containing properties set during server-side execution.
`options`	An object containing the schema option properties.

Client script global functions


Property	Description
`this.server.get([Object])`	Calls the server and sends custom `input`. Returns `Promise`.
`this.server.update()`	Calls the server and posts `this.data` to the server script. Returns `Promise`.
`this.server.refresh()`	Calls the server and automatically replaces the current options and data from the server response. Returns `Promise`.

A promise represents the eventual result of an asynchronous operation. For more information on promises, see https://promisesaplus.com/ or AngularJS documentation.

Previous topic

Next topic

Release version

Widget API reference

Service Portal includes client and server side APIs to use in widget client and server scripts.

Service Portal client-side APIs

These are Service Portal APIs that you can use in a widget client controller.

See the API reference for detailed class and method information.


Class	Description
spAriaUtil	Show messages on a screen reader.
spContextManager	Make data from a Service Portal widget available to other applications and services in a Service Portal page. For example, pass widget data to Agent Chat when it opens in a Service Portal page.
spUtil	Utility methods to perform common functions in a Service Portal widget client script.
spModal	Show alerts, prompts, and confirmation dialogs in Service Portal widgets. The SPModal class is available in Service Portal client scripts.

Note: g_form as a global object cannot be used in a widget client controller or in a UI script.

Service Portal server-side APIs

These are Service Portal APIs that you can use in a widget server script.


Class	Description
GlideSPScriptable	Interact with data and perform record operations in Service Portal widgets.
GlideSPSearchAnalytics	Generate search analytics from custom Service Portal search widgets.
spScriptedFacet	Define facet items, filters, or mapped queries for a facets object.
spScriptedFacetService	Generate a multi choice or single choice facets object for an advanced search source.

Global variable and functions available in widget client and server scripts.

Server script global objects


Property	Description
`input`	An object containing client-side properties set under `c.data`. The value is `undefined` until the client controller calls `c.server.update()`.
`data`	An object containing properties set during server-side execution.
`options`	An object containing the schema option properties.

Client script global functions


Property	Description
`this.server.get([Object])`	Calls the server and sends custom `input`. Returns `Promise`.
`this.server.update()`	Calls the server and posts `this.data` to the server script. Returns `Promise`.
`this.server.refresh()`	Calls the server and automatically replaces the current options and data from the server response. Returns `Promise`.

A promise represents the eventual result of an asynchronous operation. For more information on promises, see https://promisesaplus.com/ or AngularJS documentation.

Widget API reference

Widget API reference

Service Portal client-side APIs

Service Portal server-side APIs

Widget properties

Server script global objects

Client script global functions

Widget API reference

Widget API reference

Service Portal client-side APIs

Service Portal server-side APIs

Widget properties

Server script global objects

Client script global functions

How search works:

Topics are ranked in search results by how closely they match your search terms

Widget API reference

Widget API reference

Service Portal client-side APIs

Service Portal server-side APIs

Widget properties

Server script global objects

Client script global functions

On this page

Widget API reference

Widget API reference

Service Portal client-side APIs

Service Portal server-side APIs

Widget properties

Server script global objects

Client script global functions

Log in to personalize your search results and subscribe to topics