OpenAPI support for invoking a REST service

REST services that are defined in OpenAPI v2 and OpenAPI v3 specification files are supported, however, a few restrictions apply.

Unsupported OpenAPI specifications

The following specifications are not supported.
  • Properties allOf, oneOf, anyOf, and not are not supported.
  • Business Applications and external automation services do not support REST operations with OpenAPI definitions that include objects that are defined without properties.
  • Type integer with format int64 is not supported. If the value of the integer is greater than the supported integer number, you encounter issues.
  • OpenAPI v2 input files with $ref properties that reference elements in other locations than #/definitions/name (for schemas), #/parameters/name (for parameters), #/responses/name (for responses) are not supported.
  • OpenAPI v3 input files with $ref properties that reference elements in other locations than #/components/schemas/name (for schemas), #/components/parameters/name (for parameters), #/components/responses/name (for responses), #/components/requestBodies/name (for request bodies), or #/components/securitySchemes/name (for security schemes) are not supported.
  • OpenAPI v3 input files with $ref properties that reference properties in schema objects are not supported unless the type of the referenced property is a primitive data type.
  • Paths that contain a semicolon are not supported, even though they are valid in a URI.
  • Style deepObject for query parameters is not supported. The OpenAPI specification allows the deepObject style for serializing objects in query parameters, but there is no runtime support to serialize such objects.

Ignored OpenAPI specifications and properties

The following specifications are ignored:
  • For the HTTP methods GET, HEAD, OPTIONS, and DELETE, any request body is ignored.
  • Property default is ignored for all types.
  • Properties maxLength and minLength for type string are ignored for parameters.
  • Property multipleOf for types integer and decimal is ignored.
  • Property allowEmptyValue is ignored.
  • Schema properties maxProperties, minProperties, and additionalProperties are ignored.
  • Schema array properties maxItems and minItems are ignored.
  • Formats email, password and hostname for type string are ignored.
  • In OpenAPI v2 input files, header parameters with name Accept, Content-Type, or Authorization are ignored.
The following limitation applies:
  • Because the maximum name length of business objects is 64 characters, the names of any data types that are longer than 64 characters are shortened in the application.