Creating an encoding definition

An encoding definition defines a map between a specific schema property and its encoding information.

Before you begin

Launch the encoding definition creation window when configuring a content definition; see Editing a content definition.

About this task

  • This task relates to configuring an OpenAPI 3.0 API definition. For details on how to configure an OpenAPI 2.0 API definition, see Editing an OpenAPI 2.0 API definition.
  • OpenAPI 3.0 APIs are supported only with the DataPower® API Gateway, not with the DataPower Gateway (v5 compatible).
  • For details of current OpenAPI 3.0 support limitations, see OpenAPI 3.0 support in IBM® API Connect.

You can complete this task either by using the API Designer UI application, or by using the browser based API Manager UI.

At any time, you can switch directly to the underlying OpenAPI YAML source that corresponds to the design form in the user interface by clicking the Source icon OpenAPI Source icon. To return to the design form, click the Form icon Form icon.


  1. Provide the following information:
    • Name: The name of the schema property.
    • Content Type: The Content-Type for encoding the property; for example, application/xml; charset=utf-8, image/png, image/jpeg.
    • Style: Describes how the property value will be serialized depending on the type of the property value. Select one of the following options:
      • form: Form style properties defined by RFC6570.
      • spaceDelimited: Space separated array values.
      • pipeDelimited: Pipe separated array values.
      • deepObject: Provides a simple way of rendering nested objects using form properties.
    • Explode: When selected, property values of type array or object generate separate properties for each value of the array or key-value pair of the map.
    • Allow Reserved: Determines whether the property value should allow reserved characters, as defined by RFC3986 (:/?#[]@!$&'()*+,;=) to be included without percent-encoding.
  2. Click Create.
    The encoding definition details are displayed for further editing; see Editing an encoding definition.