Home > Class Reference > ENSLIB namespace > %Api.Mgmnt.v2.impl

%Api.Mgmnt.v2.impl

class %Api.Mgmnt.v2.impl extends %REST.Impl

The API Management API manages the APIs which are defined using a RESTSpec. In addition limited supported for legacy REST applications based on direct subclassing of %CSP.REST is included.
Business logic class defined by OpenAPI in %Api.Mgmnt.v2.spec
Updated Sep 24, 2020 17:19:32

Method Inventory

Parameters

parameter ExposeServerExceptions = 1;
If ExposeServerExceptions is true, then details of internal errors will be exposed.

Methods

classmethod CreateApplication(namespace As %String, applicationName As %String, swagger As %DynamicObject, strict As %Boolean) as %DynamicObject [ Language = objectscript ]
This request replaces an existing REST application or creates a new REST application. The request body may specify an OpenAPI 2.0 swagger description which is used to replace/create the application. If the request body is empty, then the RESTSpec and dispatch classes are replaced with any empty application.
The method arguments hold values for:
namespace, The IRIS namespace in which to perform the requested operation.
applicationName, The name of the REST application which is the package name for the classes defining and implementing the application.
swagger, The body is a JSON object containing the swagger definition for this application.
strict, If strict is false, then only the swagger properties which are needed for code generation are checked. If strict is true, then all swagger properties are checked. The value of the strict parameter defaults to true.
classmethod DeleteApplication(namespace As %String, applicationName As %String) as %DynamicObject [ Language = objectscript ]
This request deletes an application by deleting the specification class and the dispatch class that represent the application. The implementation class is not deleted.
The method arguments hold values for:
namespace, The IRIS namespace in which to perform the requested operation.
applicationName, The name of the REST application which is the package name for the classes defining and implementing the application.
classmethod GetAllRESTApps() as %DynamicObject [ Language = objectscript ]
This request returns a list of all REST applications in all namespaces as a JSON array.
classmethod GetAllWebRESTApps() as %DynamicObject [ Language = objectscript ]
This request returns a list of all %CSP.REST based REST applications in all namespaces as a JSON array.
classmethod GetApplication(namespace As %String, applicationName As %String) as %DynamicObject [ Language = objectscript ]
This request returns the OpenAPI 2.0 swagger description of this application as a JSON object.
The method arguments hold values for:
namespace, The IRIS namespace in which to perform the requested operation.
applicationName, The name of the REST application which is the package name for the classes defining and implementing the application.
classmethod GetRESTApps(namespace As %String) as %DynamicObject [ Language = objectscript ]
This request returns a list of all REST applications in the specified namespace as a JSON array.
The method arguments hold values for:
namespace, The IRIS namespace in which to perform the requested operation.
classmethod GetWebRESTApplication(namespace As %String, webApplication As %String) as %DynamicObject [ Language = objectscript ]
This request returns the OpenAPI 2.0 swagger description based on the UrlMap of %CSP.REST subclass for this REST application. The namespace parameter defaults to the web application's namespace.
The method arguments hold values for:
namespace, The IRIS namespace in which to perform the requested operation.
webApplication, The name of the web application which to which this %CSP.REST based application is deployed.
classmethod GetWebRESTApps(namespace As %String) as %DynamicObject [ Language = objectscript ]
This request returns a list of all %CSP.REST based REST applications in the specified namespace as a JSON array.
The method arguments hold values for:
namespace, The IRIS namespace in which to perform the requested operation.

Inherited Members

Inherited Methods