Namespace: Consultingwerk.Integrations.BuildOne.Swat
Class 
SwatService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.DataServiceInterface.AbstractDataService
Consultingwerk.Integrations.BuildOne.Swat.SwatService

Inherits: Consultingwerk.OERA.DataServiceInterface.AbstractDataService


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



Top Method Summary
Options Name Purpose
ApplyFieldList (JsonObject, character) Removes all fields not contained in the given field list from the serialized dataset rows
Progress.Json.ObjectModel.JsonObject BuildDatasetErrorResponse (handle) Builds the Build.One SWAT error response envelope from the validation errors of the given dataset
Progress.Json.ObjectModel.JsonObject BuildErrorResponse (Error) Builds the Build.One SWAT error response envelope for the given error
CollectBufferErrors (handle, JsonArray) Collects the ERROR-STRING values of all rows of the given buffer into the messages array
CHARACTER DefaultOrderBy (handle, character) Returns the default order-by phrase (without the BY keyword) for the given buffer, based on its unique key fields
EnsureTableArrays (JsonObject, handle) Ensures that the serialized dataset carries an (empty) array for every dataset table
Progress.Json.ObjectModel.JsonObject Fetch (JsonObject) Processes a Build.One SWAT fetch request (query interface)
CHARACTER PrepareRequest (JsonObject) Assigns the AccessToken property from the request payload and returns the validated entityName property
Progress.Json.ObjectModel.JsonObject Update (JsonObject) Processes a Build.One SWAT update request (creates, updates and deletes)

Top Property Summary
Options Name Purpose
CHARACTER AccessToken


Method Detail
Top

ApplyFieldList (JsonObject, character)
Purpose: Removes all fields not contained in the given field list from
the serialized dataset rows
Notes: The generic id and seq fields are always kept, as they carry
the record identity for the Build.One SWAT frontend

Parameters:
poData Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized dataset
pcFieldList CHARACTER
The comma-delimited list of fields to keep
Top

Progress.Json.ObjectModel.JsonObject BuildDatasetErrorResponse (handle)
Purpose: Builds the Build.One SWAT error response envelope from the
validation errors of the given dataset
Notes: Collects the ERROR-STRING values of the after- and before-image
rows of every dataset table. Validation messages carry the
affected field and table name when available (as registered by
DatasetHelper:AddErrorString) AddErrorString)

Parameters:
phDataset HANDLE
The handle of the dataset carrying validation errors
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the error response envelope
Top

Progress.Json.ObjectModel.JsonObject BuildErrorResponse (Error)
Purpose: Builds the Build.One SWAT error response envelope for the
given error
Notes: The error structure is returned instead of the data property:
success = false, error with message, type and messages array

Parameters:
poError Progress.Lang.Error
The error to build the response envelope for
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the error response envelope
Top

CollectBufferErrors (handle, JsonArray)
Purpose: Collects the ERROR-STRING values of all rows of the given
buffer into the messages array
Notes: Multiple error strings per row are separated by CHR(3); a
single error string entry optionally consists of the message,
the field name and the buffer name separated by CHR(4) (see
DatasetHelper:AddErrorString) AddErrorString)

Parameters:
phBuffer HANDLE
The buffer (after- or before-image) to collect the errors of
poMessages Progress.Json.ObjectModel.JsonArray
The JsonArray to add the error messages to
Top

CHARACTER DefaultOrderBy (handle, character)
Purpose: Returns the default order-by phrase (without the BY keyword)
for the given buffer, based on its unique key fields
Notes: A deterministic sort order is required for the stateless
skip/top paging of the Build.One SWAT frontend

Parameters:
phBuffer HANDLE
The buffer handle of the primary table
pcBufferName CHARACTER
The name of the primary table buffer
Returns CHARACTER
The order-by phrase or an empty string when the buffer has no unique key
Top

EnsureTableArrays (JsonObject, handle)
Purpose: Ensures that the serialized dataset carries an (empty) array
for every dataset table
Notes: WRITE-JSON omits tables without records - the Build.One SWAT
frontend however expects the table array to be present in
every response (e.g. an empty batch or the response of a
delete operation)

Parameters:
poData Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized dataset
phDataset HANDLE
The handle of the serialized dataset
Top

Progress.Json.ObjectModel.JsonObject Fetch (JsonObject)
Purpose: Processes a Build.One SWAT fetch request (query interface)
Notes: Expected request properties: accessToken, entityName, akQuery
(fieldlist, filters), skip, top. Returns the success envelope
with the data property containing the serialized ProDataset

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT fetch request
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the response envelope
Top

CHARACTER PrepareRequest (JsonObject)
Purpose: Assigns the AccessToken property from the request payload and
returns the validated entityName property
Notes: Shared by the Fetch and Update methods

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT request
Returns CHARACTER
The name of the Business Entity from the request
Top

Progress.Json.ObjectModel.JsonObject Update (JsonObject)
Purpose: Processes a Build.One SWAT update request (creates, updates
and deletes)
Notes: Expected request properties: accessToken, entityName, record
(the serialized ProDataset with the before-image
representation). The operation per row is derived from the
prods:rowState rowState / prods:before annotations. On success the
response mirrors the fetch envelope with the saved rows
(including trigger- or backend-assigned values); Business
Entity validation errors yield the error response envelope

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT update request
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the response envelope


Property Detail
Top

CHARACTER AccessToken

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.08.2026 05:57:51