|
Options |
Name |
Purpose |
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, character, MethodEnum)
|
/* Returns details about the operation
@param character The serviceName
@param character The relative URI
@param MethodEnum The HTTP method
@return MappedOperation The operation map for this Method/URI */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, SemanticVersion, character, MethodEnum)
|
/* Returns details about the operation
@param character The serviceName
@param SemanticVersion The service version
@param character The relative URI
@param MethodEnum The HTTP method
@return MappedOperation The operation map for this Method/URI */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperations (character, SemanticVersion)
|
/* Returns an array or operations for the service
@param character The serviceName
@param SemanticVersion The service version
@return MappedOperation[] The operations for this service */
|
|
|
|
HANDLE GetSchema (character, character)
|
/* Returns a schema for a given service oepration.
@param character The service name
@param character The schema name
@return handle An empty data structure (TT or PDS) */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService GetService (character)
|
/* Returns a the latest version of a service
@param character The name of the service to remove from the registry
@return DataObjectService A data service 'header' */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService GetService (character, character)
|
/* Returns a service object
@param character The name of the service to remove from the registry
@param character The service version to retrieve
@return DataObjectService A data service 'header' */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetServiceCatalog (character)
|
/* Returns a catalog for a named service
@param character The service name.
@return JsonObject A JSDO catalog. If no exist or none can be found, return null.
@throws AssertionFailedError If the name is empty or null
@throws AppError If the requested service does not exist in the registry */
|
|
|
|
OpenEdge.Web.DataObject.ServiceOptions GetServiceOptions (character)
|
/* Returns the service options for a named service
@param character The service name.
@return ServiceOptions A JSDO object containing options. If no exist or none can be
found, return an empty JSON object.
@throws AssertionFailedError If the name is empty or null */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService GetServices ()
|
/* Returns all registered services
@return DataObjectService[] extent An array of registered services. indeterminate if none. */
|
|
|
|
LOGICAL HasOperation (character, character, MethodEnum)
|
/* Indicates whether a mapped operation exists
@param character the service name
@param character The relative URI (to the service)
@param MethodEnum The HTTP method
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasService (character)
|
/* Indicates whether a named service is available in the registry.
@param character The name of the mapped service
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasService (character, character)
|
/* Indicates whether a named service is available in the registry.
@param character The name of the mapped service
@param character The service version
@return logical TRUE if the service exists */
|
|
|
|
RegisterAllFromFolder (character)
|
/* Registers all services found in a given folder. Can be used at agent startup
@param character An extant folder */
|
|
|
|
RegisterFromFile (character)
|
/* Registers all services found in a given file. Can be used at agent startup
@param character An extant file */
|
|
|
|
RegisterFromFile (character, character)
|
/* Registers a named service found in a given file. Can be used at agent startup
@param character A service name
@param character An extant file */
|
|
|
|
RegisterService (character, character, JsonObject, JsonObject, JsonObject)
|
/* Register a service in this handler.
@param character (mandatory) The service name.
@param JsonObject (recommended) An operation map for the service.
@param JsonObject (optional) A catalog for the service. Optional since it may exist on disk */
|
|
|
|
LOGICAL TryFindService (character, character)
|
/* Indicates whether a named service is available. Will attempt to
locate a service map if it is not yet registered, and will register
it if one can be found.
@param character The name of the mapped service
@param character The name of the webapp currently executed
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL TryFindService (character, character, character)
|
/* Indicates whether a named service is available. Will attempt to
locate a service map if it is not yet registered, and will register
it if one can be found.
@param character The name of the mapped service
@param character A version of the service to load
@param character The name of the webapp currently executed
@return logical TRUE if the service exists */
|