Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [REST] >  [GenericService]
Private  Storage   

class EnsLib.REST.GenericService extends EnsLib.HTTP.GenericService

Generic REST Service based BusinessService class. Can use an HTTP InboundAdapter listener, or the standard CSP Service mechanism, or both. In order for the CSP mechanism to work, HTTP Services using this class must be configured with the invoking URL including ?CfgItem= giving the config item name. (Configured Services exposed using the HTTP Inbound Adapter may also be invoked with this URL parameter but because each configured Inbound Adapter listens on its own TCP/IP port this parameter is just a safety check for them.)

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers


Summary

This is a Business Service class.

The associated Adapter class is EnsLib.HTTP.InboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%ExcludeResponseHttpHeaders %LastActionTime %LastHandledTime
%LastReportedError %OutsideCreated %PreserveSession
%ProcessInputCalled %QuitTask %RequestHeader
%SessionId %SuperSession %SuperSessionCreatedBeforeSession
%WaitForNextCallInterval %WarnedLatest %isShadow
Adapter AlertGracePeriod AlertGroups
AlertOnError ArchiveIO BusinessPartner
CSPNoCharSetConvert EnableStandardRequests GenerateSuperSessionID
IOLogEntry InactivityTimeout KeepCSPPartition
OneWay PersistInProcData SearchTableClass
TargetConfigName ThrottleDelay Validation

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry ConvertParameter Decrypt
Encrypt EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch
EscapeHTML EscapeURL ForceSessionId GenerateSuperSession
GetDeferredResponseToken GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link NewIOLogEntry OnAdapterHTTPResponse
OnError OnErrorStream OnGenerateSuperSession OnGetConnections
OnHTTPHeader OnInit OnKeepalive OnMonitor
OnPageError OnPostHyperEvent OnPreHTTP OnPreHyperEvent
OnProcessInput OnProductionStart OnProductionStop OnResolveDocType
OnTearDown OnValidate Page PopulateSuperSession
QueueName QuoteJS RewriteURL SaveIOLogEntry
SendAlert SendDeferredResponse SendRequestAsync SendRequestSync
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL findDataNotInQuery resolveAndIndex
resolveDocType restoreFormEncoded restoreMultipart

Subclasses
EnsLib.REST.SAMLGenericService



Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.