Page History

OAS

OpenAPI version (4.1)

Version number in the URL of the feed (see also: OpenAPI feed).

-

Title (4.8.2.1)

OpenAPI title in project in Encore. If empty: “…”"Blueriq Rest Services”.

Project

Description (4.8.2.1)

OpenAPI description in project in Encore. If empty: “…”“A specification of the rest services available in the Blueriq Runtime”.

Project

Server url (4.8.5)

URL of the runtime server from which the feed is generated.

-

Operation tag (group) (4.8.22)

Name of the rest service element in which the operation is defined in Encore.

Rest REST service

Path item object (4.8.9)

Name of the web service /[Web service name of element in Encore + / + Fragments]/[Fragment defined in rest service in Encore]

Web service, REST service

Operation object (4.8.10)

Selected HTTP method of the operation in rest service in Encore.

Rest REST service

Operation summary (4.8.10)

Name of operation in rest service in Encore.

Rest REST service

Operation description (4.8.10)

OpenAPI Description of operation in rest service in Encore

Rest REST service

Operation id (4.8.10)

Name of webservice + Name of operation in rest service in Encore

Web service, rest  REST service

Operation parameters (4.8.12)

HeadersA collection of all (Except for constant fragments but including constant arguments!) headers, arguments, and fragments in operation in rest service in Encore, including its properties such as OpenAPI description, whether it the parameter is required, OpenAPI description, values of a value list that is attached to an attribute in case of a dynamic parameter.

Rest REST service, value list, attribute, value list

Request body (4.8.13)

Request domain schema in operation in rest service in Encore.

Rest REST service

Response 200 OK (4.8.17)

Response domain schema in operation in rest service in Encore.

Rest REST service

Other responses (4.8.17)

Default runtime responses named RestErrorResponse, InvalidJsonPathDetail, and InvalidJsonResponse that are used for default error responses (400, 401, 403, 404, 406, 500)

-

Schema (4.8.24)

[ModuleName]_[DomainschemaName]

Module, domain schema

Schema propertyproperties  (4.8.24)

Properties of a domain schema item, containing the name, data type, whether its required, whether its multivalued, OpenAPI description, values of a value list that is attached to an attribute that is mapped to a domain schema field.

Domain schema, attribute, value list