Skip to main content
Version: 5.2.0.0

Response

Configuration​

For each method, the user can define corresponding responses.

Display and Configure a Response​

Click on the Response to display and edit its properties.
Response of the method

  • Media Type: Defines the format of the method response. If you click on the Example button, you can add an example for the response message. This example is added when exporting the service as OpenAPI specification.

  • Native content: If the media type is text/xml, application/xml, or application/json, the response's content is automatically deserialized using the appropriate deserializer.
    If the media type is application/json, the checkbox Native content becomes selectable. If selected, the content is not deserialized to a structured DOM message; instead, a native JSON message is created.

  • Message Type: Defines the internal Message Type to use for the response. This information is used to configure the JSON reader with the appropriate message type.
    In the configuration of the serializers, you must select <configured type> to ensure that this message type will be used in the JSON reader.

  • JSON schema: In OpenAPI, the content of a response is defined by a JSON schema. You can display and edit this schema by clicking on the Edit schema button.
    Typically, the schema of a response is a reference to a JSON schema contained in a scenario element of type Resource. If an OpenAPI specification is imported, all the schemas contained in the components part of the specification are imported into a new Resource.

  • Status Code: Here, the user can enter all allowed result codes for this response. The result codes in this field must be separated by a space character.
    At execution time, the values in this field (if present) are used to match the generated response. If the field is empty, any response code is accepted.
    For example, you could declare that in the case of success (result code 200), the resulting media type should be JSON, whereas in any other case, the resulting media type should be HTML.

  • Headers: Defines the Response headers. For each header, a Response parameter is generated, which can then be assigned to an appropriate variable in the process model.