Namespace: Consultingwerk.OERA.RestResource
Class 
RestEntitiesWebHandler Copy to Clipboard
Parent classes:
OpenEdge.Web.WebHandler
Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
Consultingwerk.OERA.RestResource.RestEntitiesWebHandler

Inherits: Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
Activate () Wrapper to the call to ServiceInterface:Activate
Activate (IWebRequest) Wrapper to the call to ServiceInterface:Activate
AddCookieValues (IWebRequest, character, Object) Sets property values on a parameter object to cookie values
AddHeaderValues (IWebRequest, character, Object) Sets property values on a parameter object to header values
AddResponseDataset (JsonObject, character, handle[]) Adds a dataset to the JSON response
AssignParameterPropertiesFromPath (Object, IRestRequest) Assigns properties of the parameter object from the request's query string
AssignParameterPropertiesFromQueryString (Object, IWebRequest) Assigns properties of the parameter object from the request's query string
AssignParameterPropertiesFromRequestEntity (Object, Object) Assigns properties of the parameter object from the request payload
AssignPropertyValue (Object, Property, character) Assigns a property value form a string value
Progress.Json.ObjectModel.JsonConstruct BuildCollectionResponse (handle, IWebRequest, IRestRequest, character, character) Returns the response JsonArray for a collection record
Consultingwerk.OERA.INamedQueryParameter BuildNamedQuery (IRestRequest, IWebRequest) Builds a INamedQueryParameter instance from the current Rest Address
Progress.Json.ObjectModel.JsonObject BuildRecordResponse (handle, IWebRequest, IRestRequest) Returns the response JsonObject for a single record
CheckFieldAuthorization (handle, JsonObject) Checks for field authorization during update
Deactivate () Wrapper to the call to ServiceInterface:Deactivate
Deactivate (IWebRequest) Wrapper to the call to ServiceInterface:Deactivate
CHARACTER ExpandFields (character, character, handle) Ensures a list of fields are qualified with table names.
Consultingwerk.OERA.IFetchDataRequest FetchDataRequestFromRestRequest (IRestRequest, IWebRequest, logical, handle, logical) Builds an FetchDataRequest from the current Rest Request
Consultingwerk.OERA.IFetchDataRequest FetchDataRequestFromRestRequest (IRestRequest, IWebRequest, logical, handle, logical, character, character) Builds an FetchDataRequest from the current Rest Request
FilterString (URI, handle, ListQueryExpression) Builds a query string based on the URI Query
CHARACTER FormatDate (date) Produces a string version of a date, formatted per the application's DATE-FORMAT. This may not be the current SESSION DATE-FORMAT, particularly if the EnforceAmericanSettings property is TRUE.
CHARACTER FormatDateTime (datetime) Produces a string version of a datetime, formatted per the application's DATE-FORMAT. This may not be the current SESSION DATE-FORMAT, particularly if the EnforceAmericanSettings property is TRUE.
CHARACTER FormatDateTimeTz (datetime-tz) Produces a string version of a date, formatted per the application's DATE-FORMAT. This may not be the current SESSION DATE-FORMAT, particularly if the EnforceAmericanSettings property is TRUE.
Progress.Json.ObjectModel.JsonObject GetInitialValues (IRestRequest, IWebRequest) Gets the initial values for an entity
CHARACTER HandleDatasetControlString (handle) Checks for a Dataset Control string as part of the Questions API
INTEGER HandleDelete (IWebRequest) Handles the DELETE request
HandleDeleteRequest (IWebRequest, IHttpResponse) Performs the processing of a DELETE request
INTEGER HandleGet (IWebRequest) Handles the GET request
HandleGetRequest (IWebRequest, IHttpResponse) Performs the processing of a GET request
INTEGER HandlePatch (IWebRequest) Handles the PATCH request
HandlePatchRequest (IWebRequest, IHttpResponse) Performs the processing of a GET request
INTEGER HandlePost (IWebRequest) Handles the POST request
HandlePostRequest (IWebRequest, IHttpResponse) Performs the processing of a POST request
INTEGER HandlePut (IWebRequest) Handles the PUT request
HandlePutRequest (IWebRequest, IHttpResponse) Performs the processing of a POST request
Progress.Json.ObjectModel.JsonConstruct InitializeJsonParameterObject (IRestRequest, IWebRequest) Initializes the JSON Parameter Object instance
Progress.Lang.Object InitializeParameterObject (IRestRequest, IWebRequest, Object, character) Creates and initializes the Parameter Object instance
InitializeRequestArguments (IRestRequest, IWebRequest, Method, handle, handle, handle, handle, handle, Object) Initializes the JSON Parameter Object instance
InvokeErrorHandler (Error, IHttpResponse) Invokes the error handler
Progress.Lang.Object InvokeMethod (IRestRequest, IWebRequest) Invokes a method of a Business Task or Business Entity
ProcessHttpResponse (IHttpResponse, IHttpRequest, IRestRequest) Tests if the invoked service supports the HTTP response processing and invokes the UpdateHttpResponse method
Consultingwerk.ListSortField ProcessSortString (character, character, handle) Processes the Sort String
LOGICAL VerifyMethodSignature (Parameter[]) Verifies if the method signature is compatible to the Service Interface

Top Constructor Summary
Options Name Purpose
RestEntitiesWebHandler () Constructor for the RestEntitiesWebHandler class

Top Property Summary
Options Name Purpose
LOGICAL EnforceAmericanSettings
LOGICAL FilterIsoDates
LOGICAL IgnoreIncompatibleCharacters


Method Detail
Top

Activate ()
Purpose: Wrapper to the call to ServiceInterface:Activate
Notes:

Top

Activate (IWebRequest)
Purpose: Wrapper to the call to ServiceInterface:Activate
Notes: This method can be overridden by customers implementing
custom authentication schemes (e.g. API Key)

Parameters:
poRequest OpenEdge.Web.IWebRequest
The reference to the current web request
Top

AddCookieValues (IWebRequest, character, Object)
Purpose: Sets property values on a parameter object to cookie values
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The HTTP request
pcMapCookies CHARACTER
A comma-delimited list of cookie names to map
poParameter Progress.Lang.Object
The parameter object
Top

AddHeaderValues (IWebRequest, character, Object)
Purpose: Sets property values on a parameter object to header values
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The HTTP request
pcMapHeaders CHARACTER
A comma-delimited list of header names to map
poParameter Progress.Lang.Object
The parameter object
Top

AddResponseDataset (JsonObject, character, handle[])
Purpose: Adds a dataset to the JSON response
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The response JSON to add the dataset to
pcDatasetName CHARACTER
The name of the Dataset to add to the response
phDatasets HANDLE
The handles of the Datasets
Top

AssignParameterPropertiesFromPath (Object, IRestRequest)
Purpose: Assigns properties of the parameter object from the request's query string
Notes:

Parameters:
poParameter Progress.Lang.Object
The reference to the instance of the parameter object
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance
Top

AssignParameterPropertiesFromQueryString (Object, IWebRequest)
Purpose: Assigns properties of the parameter object from the request's query string
Notes:

Parameters:
poParameter Progress.Lang.Object
The reference to the instance of the parameter object
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance
Top

AssignParameterPropertiesFromRequestEntity (Object, Object)
Purpose: Assigns properties of the parameter object from the request payload
Notes:

Parameters:
poParameter Progress.Lang.Object
The reference to the instance of the parameter object
poEntity Progress.Lang.Object
The Request Entity
Top

AssignPropertyValue (Object, Property, character)
Purpose: Assigns a property value form a string value
Notes:

Parameters:
poObject Progress.Lang.Object
The reference to the object instance who's property should be assigned
poProperty Progress.Reflect.Property
The reference to the Progress.Reflect.Property instance
pcValue CHARACTER
The character value
Top

Progress.Json.ObjectModel.JsonConstruct BuildCollectionResponse (handle, IWebRequest, IRestRequest, character, character)
Purpose: Returns the response JsonArray for a collection record
Notes:

Parameters:
phDataset HANDLE
The dataset that contains the response records
poRequest OpenEdge.Web.IWebRequest
The IWebRequest
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The REST Request instance representing the current request
pcQuerySort CHARACTER
The query sort
pcFields CHARACTER
The fields parameter provided by the consumer
Returns Progress.Json.ObjectModel.JsonConstruct
The JSON Response entity
Top

Consultingwerk.OERA.INamedQueryParameter BuildNamedQuery (IRestRequest, IWebRequest)
Purpose: Builds a INamedQueryParameter instance from the current Rest Address
Notes: The format of the RestAddress:NamedQueryParameter is
1) parameter-name
2) query-string-name=parameter-name
3) parameter-name:parameter-datatype
4) query-string-name=parameter-name:parameter-datatype
For 1) and 3) the query name is the same as the parameter name

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance for the current request
poWebRequest OpenEdge.Web.IWebRequest
The IWebRequest instance of the current request
Returns Consultingwerk.OERA.INamedQueryParameter
A INamedQueryParameter instance. May be unknown.
Top

Progress.Json.ObjectModel.JsonObject BuildRecordResponse (handle, IWebRequest, IRestRequest)
Purpose: Returns the response JsonObject for a single record
Notes:

Parameters:
phDataset HANDLE
The dataset that contains the response records
poRequest OpenEdge.Web.IWebRequest
The IWebRequest
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The REST Request instance representing the current request
Returns Progress.Json.ObjectModel.JsonObject
The JSON Response entity
Top

CheckFieldAuthorization (handle, JsonObject)
Purpose: Checks for field authorization during update
Notes:

Parameters:
phBuffer HANDLE
Then handle of the buffer
poJson Progress.Json.ObjectModel.JsonObject
The JSON Entity
Top

Deactivate ()
Purpose: Wrapper to the call to ServiceInterface:Deactivate
Notes:

Top

Deactivate (IWebRequest)
Purpose: Wrapper to the call to ServiceInterface:Deactivate
Notes: This method can be overridden by customers implementing
custom authentication schemes (e.g. API Key)

Parameters:
poRequest OpenEdge.Web.IWebRequest
The reference to the current web request
Top

CHARACTER ExpandFields (character, character, handle)
Purpose: Ensures a list of fields are qualified with table names.
Notes: - If the dataset is not passed in, then table.* values are not resolved.
- Invalid (could not be found in the dataset) field names are skipped.

Parameters:
pcFields CHARACTER
Comma-delimited list of fields. Values may be field-name, table.field
pcTable CHARACTER
The table being filtered by the request. Acts as the default table name.
phDataset HANDLE
The dataset being populated. Unknown/invalid for PUT and PATCH operations.
Returns CHARACTER
The table-qualified field list
Top

Consultingwerk.OERA.IFetchDataRequest FetchDataRequestFromRestRequest (IRestRequest, IWebRequest, logical, handle, logical)
Purpose: Builds an FetchDataRequest from the current Rest Request
Notes:
hold the query; if FALSE, a query string will be built

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance for the current request
poWebRequest OpenEdge.Web.IWebRequest
The IWebRequest instance of the current request
plAddQueryString LOGICAL
Add the ?QueryString values to the query
phBuffer HANDLE
The handle of the query buffer
plUseQueryExpression LOGICAL
If TRUE, the FetchDataRequest will use its QueryExpressionWithSort property to
Returns Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest instance
Top

Consultingwerk.OERA.IFetchDataRequest FetchDataRequestFromRestRequest (IRestRequest, IWebRequest, logical, handle, logical, character, character)
Purpose: Builds an FetchDataRequest from the current Rest Request
Notes:
hold the query; if FALSE, a query string will be built

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance for the current request
poWebRequest OpenEdge.Web.IWebRequest
The IWebRequest instance of the current request
plAddQueryString LOGICAL
Add the ?QueryString values to the query
phBuffer HANDLE
The handle of the query buffer
plUseQueryExpression LOGICAL
If TRUE, the FetchDataRequest will use its QueryExpressionWithSort property to
pcQuerySort CHARACTER
The query sort string (OUTPUT)
pcFields CHARACTER
The consumer provided field list (OUTPUT)
Returns Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest instance
Top

FilterString (URI, handle, ListQueryExpression)
Purpose: Builds a query string based on the URI Query
Notes:

Parameters:
poURI OpenEdge.Net.URI
The URI
phBuffer HANDLE
The handle of the buffer to determine field names based on serializable-name
poListQueryExpression Consultingwerk.ListQueryExpression
A ListQueryExpression based on the URI Query
Top

CHARACTER FormatDate (date)
Purpose: Produces a string version of a date, formatted per the
application's DATE-FORMAT. This may not be the current
SESSION DATE-FORMAT, particularly if the EnforceAmericanSettings
property is TRUE.
Notes:

Parameters:
pdaDate DATE
The date to format
Returns CHARACTER
A string version of the date, per the session's DateFormat
Top

CHARACTER FormatDateTime (datetime)
Purpose: Produces a string version of a datetime, formatted per the
application's DATE-FORMAT. This may not be the current
SESSION DATE-FORMAT, particularly if the EnforceAmericanSettings
property is TRUE.
Notes:

Parameters:
pdtDate DATETIME
The datetime to format
Returns CHARACTER
A string version of the datetime, per the session's DateFormat
Top

CHARACTER FormatDateTimeTz (datetime-tz)
Purpose: Produces a string version of a date, formatted per the
application's DATE-FORMAT. This may not be the current
SESSION DATE-FORMAT, particularly if the EnforceAmericanSettings
property is TRUE.
Notes:

Parameters:
pdtzDate DATETIME-TZ
The datetime-tz to format
Returns CHARACTER
A string version of the datetime-tz, per the session's DateFormat
Top

Progress.Json.ObjectModel.JsonObject GetInitialValues (IRestRequest, IWebRequest)
Purpose: Gets the initial values for an entity
Notes:

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance for the current request
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance of the current request
Returns Progress.Json.ObjectModel.JsonObject
The JSON response containing the initial values (custom or default)
Top

CHARACTER HandleDatasetControlString (handle)
Purpose: Checks for a Dataset Control string as part of the Questions API
Notes:

Parameters:
phDataset HANDLE
The handle of the ProDataset
Returns CHARACTER
The message to return
Top

INTEGER HandleDelete (IWebRequest)
Purpose: Handles the DELETE request
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
Returns INTEGER
The http status code
Top

HandleDeleteRequest (IWebRequest, IHttpResponse)
Purpose: Performs the processing of a DELETE request
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
poResponse OpenEdge.Net.HTTP.IHttpResponse
The response
Top

INTEGER HandleGet (IWebRequest)
Purpose: Handles the GET request
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
Returns INTEGER
The http status code
Top

HandleGetRequest (IWebRequest, IHttpResponse)
Purpose: Performs the processing of a GET request
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
poResponse OpenEdge.Net.HTTP.IHttpResponse
The response
Top

INTEGER HandlePatch (IWebRequest)
Purpose: Handles the PATCH request
Notes: Updates the provided properties of the given resource

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
Returns INTEGER
The http status code
Top

HandlePatchRequest (IWebRequest, IHttpResponse)
Purpose: Performs the processing of a GET request
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
poResponse OpenEdge.Net.HTTP.IHttpResponse
The response
Top

INTEGER HandlePost (IWebRequest)
Purpose: Handles the POST request
Notes: Creates a new record in a collection

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
Returns INTEGER
The http status code
Top

HandlePostRequest (IWebRequest, IHttpResponse)
Purpose: Performs the processing of a POST request
Notes: Creates a new record in a collection

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
poResponse OpenEdge.Net.HTTP.IHttpResponse
The response
Top

INTEGER HandlePut (IWebRequest)
Purpose: Handles the PUT request
Notes: Update a single resource

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
Returns INTEGER
The http status code
Top

HandlePutRequest (IWebRequest, IHttpResponse)
Purpose: Performs the processing of a POST request
Notes: Creates a new record in a collection

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
poResponse OpenEdge.Net.HTTP.IHttpResponse
The response
Top

Progress.Json.ObjectModel.JsonConstruct InitializeJsonParameterObject (IRestRequest, IWebRequest)
Purpose: Initializes the JSON Parameter Object instance
Notes: Supports JsonObject, JsonArray and JsonConstruct

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance describing the method to be invoked
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance describing the client request
Returns Progress.Json.ObjectModel.JsonConstruct
The parameter object instance
Top

Progress.Lang.Object InitializeParameterObject (IRestRequest, IWebRequest, Object, character)
Purpose: Creates and initializes the Parameter Object instance
Notes:
will be used

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance describing the method to be invoked
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance describing the client request
poEntity Progress.Lang.Object
The Request Entity or "parameter" property
pcParameterClassName CHARACTER
The parameter class name. If not specified, the value from the RestRequest's RestMethod
Returns Progress.Lang.Object
The parameter object instance
Top

InitializeRequestArguments (IRestRequest, IWebRequest, Method, handle, handle, handle, handle, handle, Object)
Purpose: Initializes the JSON Parameter Object instance
Notes:

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance describing the method to be invoked
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance describing the client request
poMethod Progress.Reflect.Method
The Progress.Reflect.Method for the method to be called
phDataset1 HANDLE
OUTPUT The handle of the first ProDataset
phDataset2 HANDLE
OUTPUT The handle of the second ProDataset
phDataset3 HANDLE
OUTPUT The handle of the third ProDataset
phDataset4 HANDLE
OUTPUT The handle of the fourth ProDataset
phDataset5 HANDLE
OUTPUT The handle of the fifth ProDataset
poParameter Progress.Lang.Object
OUTPUT The parameter object instance
Top

InvokeErrorHandler (Error, IHttpResponse)
Purpose: Invokes the error handler
Notes: This method is expected to be overridden to change the JSON error details

Parameters:
poError Progress.Lang.Error
An instance of a Progress.Lang.Error
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response instance returned to the client
Top

Progress.Lang.Object InvokeMethod (IRestRequest, IWebRequest)
Purpose: Invokes a method of a Business Task or Business Entity
Notes:

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest instance describing the method to be invoked
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance describing the client request
Returns Progress.Lang.Object
The response entity
Top

ProcessHttpResponse (IHttpResponse, IHttpRequest, IRestRequest)
Purpose: Tests if the invoked service supports the HTTP response processing
and invokes the UpdateHttpResponse method
Notes:

Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
The IHttpResponse to be returned to the resource requester
poRequest OpenEdge.Net.HTTP.IHttpRequest
The IHttpRequest issues by the consumer
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest (processed by the RestEntitiesWebHandler) representing the current request
Top

Consultingwerk.ListSortField ProcessSortString (character, character, handle)
Purpose: Processes the Sort String
Notes:

Parameters:
pcSort CHARACTER
The sort string, e.g. +City,-Name
pcTableName CHARACTER
The name of the table
phBuffer HANDLE
The handle of the buffer to determine field names based on serialize-name
Returns Consultingwerk.ListSortField
The resulting query sort expression
Top

LOGICAL VerifyMethodSignature (Parameter[])
Purpose: Verifies if the method signature is compatible to the Service Interface
Notes:

Parameters:
poParameters Progress.Reflect.Parameter
The method's Parameter list
Returns LOGICAL
Logical value indicating if the method signature is supported by the Service Interface


Constructor Detail
Top

RestEntitiesWebHandler ()
Purpose: Constructor for the RestEntitiesWebHandler class
Notes:



Property Detail
Top

LOGICAL EnforceAmericanSettings

Returns LOGICAL
Top

LOGICAL FilterIsoDates

Returns LOGICAL
Top

LOGICAL IgnoreIncompatibleCharacters

Returns LOGICAL


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:22:38