Namespace: Consultingwerk.OERA.Swagger
Interface 
ISwaggerDefinitionGenerator Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.OERA.Swagger.SwaggerDefinitionGenerator

File:ISwaggerDefinitionGenerator
Purpose:Interface for classes that can generate the JSON/JSDO
Swagger Definitions
Author(s):Martyn Kemp / Consultingwerk Ltd.
Created:Wed Aug 02 13:03:59 BST 2017

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



Top Method Summary
Options Name Purpose
+ Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character) Returns the Catalog for a given Business Entity
+ GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character, longchar) Returns the Catalog for a given Business Entity
+ Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress, character) Returns the Catalog for a given Business Task


Method Detail
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character)
Purpose: Returns the Catalog for a given Business Entity
Notes: Defaults to the count method type of the .restapplicationsettings file

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcServiceURI CHARACTER
The Service URI
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object describing the Catalog for the Business Entity
Top

PUBLIC GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character, longchar)
Purpose: Returns the Catalog for a given Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcServiceURI CHARACTER
The Service URI
pcJsonCatalog LONGCHAR
OUTPUT The JSON Catalog for the Business Entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress, character)
Purpose: Returns the Catalog for a given Business Task
Notes:

Parameters:
poBusinessTask Consultingwerk.OERA.IBusinessTaskCatalogData
The name of the Business Task
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcServiceURI CHARACTER
The Service URI
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object describing the Catalog for the Business Task


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:14:59