API Responses
Every operation needs at least one response, usually a success and an error response.
Create a Response
A response can be created in the Responses tab of a domain namespace's Overview page by using the Create capability.
Responses are defined using the following master data:
| Property | Description |
| Identifier |
This is the identifier 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 responses! Furthermore, names may not begin with a digit and the first character must be uppercase. The identifier cannot be changed after creation. This field is mandatory. |
| Content Type |
It is a mapping of the representations for the parameter. There is only one type of content representation: application/json. This field is mandatory only if a schema type has been selected. |
| Schema |
This is a list of all the complex schema types (objects, oneOfs and arrays) that have already been created. The one chosen will be the schema type of the response that s being created. Response schemas can only be of type Array/Object/oneOf
This field is optional. |
| Description |
This is used to give a longer description of the response.
This field is mandatory. |
Edit a Response
You can edit a response by using the Information capability, navigating to the Master Data section and using the Edit Master Data capability or by using the inline Edit capability. The fields that can be edited are the content type, the schema and the description.
Delete a Response
You can delete the response by using the inline Delete capability. Alternatively, you can use the Information capability to access the Details view and there you can use the Delete capability.
You will need to confirm the action before the selected response is permanently deleted.