1. Home
  2. Globals

Globals

All documented globals.

Type Definitions

ServiceControllerGeneralOptions

Description

The type of ServiceController#options which are options for all kind of requests if you use common or refined per particular http method.

Properties
Name Type Description
common ServiceControllerOptions

options that apply to all requests
get ServiceControllerOptions

options that apply to get requests
put ServiceControllerOptions

options that apply to put requests
post ServiceControllerOptions

options that apply to post requests
delete ServiceControllerOptions

options that apply to delete requests

ServiceControllerOptions

Description

Request options. The needed permissions, validations, etc.

Properties
Name Type Description
requirePermissions any

. Object indicating required permissions of the user invoking the service. Other whise it will respond with 503 error. Example:

 requirePermissions: {
					list: ['lists.listCase.1'],
				},
					```
requireSecure Boolean

If http protocol is not secure it will throw an error
validateLoggedInPPS Boolean

Verifies if user is not logged in and Pwd protected site is enabled, and if registration is enabled
requireLogin Boolean

If user not logged in it will throw an error
checkLoggedInCheckout Boolean

Pass only if we are not in checkout OR if we are logged in