The API Management API manages the APIs which are defined using a RESTSpec. More...

Inheritance diagram for impl:

[legend]

Collaboration diagram for impl:

[legend]

Static Public Member Functions
_.Library.DynamicObject	CreateApplication (_.Library.String namespace, _.Library.String applicationName, _.Library.DynamicObject swagger, _.Library.Boolean strict)
	This request replaces an existing REST application or creates a new REST application. More...

_.Library.DynamicObject	DeleteApplication (_.Library.String namespace, _.Library.String applicationName)
	This request deletes an application by deleting the specification class and the dispatch class that represent the application. More...

_.Library.DynamicObject	GetAllRESTApps ()
	This request returns a list of all REST applications in all namespaces as a JSON array.

_.Library.DynamicObject	GetAllWebRESTApps ()
	This request returns a list of all CSP.REST based REST applications in all namespaces as a JSON array.

_.Library.DynamicObject	GetApplication (_.Library.String namespace, _.Library.String applicationName)
	This request returns the OpenAPI 2.0 swagger description of this application as a JSON object. More...

_.Library.DynamicObject	GetRESTApps (_.Library.String namespace)
	This request returns a list of all REST applications in the specified namespace as a JSON array. More...

_.Library.DynamicObject	GetWebRESTApplication (_.Library.String namespace, _.Library.String webApplication)
	This request returns the OpenAPI 2.0 swagger description based on the UrlMap of CSP.REST subclass for this REST application. More...

_.Library.DynamicObject	GetWebRESTApps (_.Library.String namespace)
	This request returns a list of all CSP.REST based REST applications in the specified namespace as a JSON array. More...

Static Public Attributes
	ExposeServerExceptions = None
	The API Management API manages the APIs which are defined using a RESTSpec. More...

Static Public Attributes inherited from Impl
	ExposeServerExceptions = None
	If ExposeServerExceptions is overridden as true, then details of internal errors will be exposed.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Detailed Description

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 Mar 7, 2024 16:10:28

Member Function Documentation

◆ CreateApplication()

_.Library.DynamicObject CreateApplication	(	_.Library.String	namespace,
		_.Library.String	applicationName,
		_.Library.DynamicObject	swagger,
		_.Library.Boolean	strict
	)

static

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.

◆ DeleteApplication()

_.Library.DynamicObject DeleteApplication	(	_.Library.String	namespace,
		_.Library.String	applicationName
	)

static

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.

◆ GetApplication()

_.Library.DynamicObject GetApplication	(	_.Library.String	namespace,
		_.Library.String	applicationName
	)

static

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.

◆ GetRESTApps()

_.Library.DynamicObject GetRESTApps ( _.Library.String namespace )

static

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.

◆ GetWebRESTApplication()

_.Library.DynamicObject GetWebRESTApplication	(	_.Library.String	namespace,
		_.Library.String	webApplication
	)

static

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.

◆ GetWebRESTApps()

_.Library.DynamicObject GetWebRESTApps ( _.Library.String namespace )

static

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.

Member Data Documentation

◆ ExposeServerExceptions

ExposeServerExceptions = None

static

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 Mar 7, 2024 16:10:28

If ExposeServerExceptions is true, then details of internal errors will be exposed.

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateApplication()

◆ DeleteApplication()

◆ GetApplication()

◆ GetRESTApps()

◆ GetWebRESTApplication()

◆ GetWebRESTApps()

Member Data Documentation

◆ ExposeServerExceptions