Skip to main content

%pkg.isc.rest.openAPI.model.responses

persistent class %pkg.isc.rest.openAPI.model.responses extends %pkg.isc.rest.openAPI.model.passthroughObject

SQL Table Name: %pkg_isc_rest_openAPI_model.responses

A representation of the OpenAPI Specification Responses Object (see http://spec.openapis.org/oas/v3.0.3#responsesObject) JSON Representation is the inline (not as a separate object) contents of ..Data, through use of %pkg.isc.rest.openAPI.model.passthroughObject

Property Inventory

Method Inventory

Parameters

parameter EXTENSIBLE = 1;
@Override: Per the OpenAPI Specification, this object may be extended with "x-*" properties.
parameter KEYREGEX = default|[1-5](XX|[0-9]{2});
Acceptible key regex (from description at http://spec.openapis.org/oas/v3.0.3#responsesObject)

Properties

@Special: This Object's content @OpenAPI: A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. @OpenAPI: The default [array key] MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.
Property methods: Data(), DataBuildValueArray(), DataCollectionToDisplay(), DataCollectionToOdbc(), DataDisplayToCollection(), DataGet(), DataGetObject(), DataGetObjectId(), DataGetStored(), DataGetSwizzled(), DataIsValid(), DataOdbcToCollection(), DataSet(), DataSetObject(), DataSetObjectId()
property SourceClasses as list of %String (%JSONINCLUDE = "none", MAXLEN = 220);
Used to track the class(es) that caused this object to be generated. MAXLEN to match %Dictionary.Classname. MUST use %String or else cannot save due to lack of Normalize() method in %Dictionary.Classname.
Property methods: SourceClassesBuildValueArray(), SourceClassesCollectionToDisplay(), SourceClassesCollectionToOdbc(), SourceClassesDisplayToCollection(), SourceClassesDisplayToLogical(), SourceClassesGet(), SourceClassesGetObject(), SourceClassesGetObjectId(), SourceClassesGetStored(), SourceClassesGetSwizzled(), SourceClassesIsValid(), SourceClassesLogicalToDisplay(), SourceClassesLogicalToOdbc(), SourceClassesNormalize(), SourceClassesOdbcToCollection(), SourceClassesSet(), SourceClassesSetObject(), SourceClassesSetObjectId()

Methods

method RemoveAllFromSource(className As %String, Output keepSelf As %Boolean)
method Validate(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI = "", debug=0) as %Boolean
@Override: Object-specific validation logic within a given OpenAPI Specification (use ..ValidateComponent() for full validation)

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%pkg.isc.rest.openAPI.model.super)

^pkg.isc.rest.oas.model.superD(ID)
=
%%CLASSNAME

Storage Model: Storage (%pkg.isc.rest.openAPI.model.extensibleSuper)

^pkg.isc.rest.oas.model.superD(ID,"%pkg.isc.rest.openAPI.model.extensibleSuper.Extras",n)
=
Extras(n)

Storage Model: Storage (%pkg.isc.rest.openAPI.model.responses)

^pkg.isc.rest.oas.model.superD(ID,"%pkg.isc.rest.openAPI.model.responses.Data",n)
=
Data(n)

Storage Model: Storage (%pkg.isc.rest.openAPI.model.responses)

^pkg.isc.rest.oas.model.superD(ID,"Responses")
=
SourceClasses
FeedbackOpens in a new tab