Responses

A response can be created in the Responses tab of an API Namespace's Overview page by using the Create response capability.

Responses are defined using the following master data:

• Identifier: This is the identifier (name) of the response. It is unique within a namespace. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming response! Furthermore, names may not begin with a digit and the first character must be uppercase. The identifier cannot be changed after creation.
• Required: This is a Boolean. If it is checked then the response is required, otherwise it is optional
• Content Type: It is a selection element with only one choice: application/json. This field is mandatory only if a schema type has been selected
• Schema: This is a list of all the schema types that have already been created. The one chosen will be the schema type of the response that s being created. responses can only be of type Array/Object/OneOf (required)
• Description: This is used to give a longer description of the response (optional)

You can edit the master data of a response by clicking the Edit response details button in the Response Details section on the response's instance page. Alternatively, you can use the Edit capability of each table row on the Responses tab of a api namespace's Overview page. The fields that can be edited are the Content Type, the Schema and the Description.

You can delete a response by clicking the Delete response button in the upper right corner of the response instance page. Alternatively, you can use the Delete capability of each table row on the Responses tab of a api namespace's Overview page.

You will need to confirm the action before the selected response is permanently deleted.