Managing Operations

Create an Operation (POST, GET, PUT, DELETE)

You can create an operation by using the corresponding capability (POST, GET, PUT, DELETE).

Operations are defined using the following master data:


Property	Description
Operation Id	This is the name of the operation. It is unique within an API namespace. The operation Id is case sensitive. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming entities! The operation id cannot be changed after creation. It is recomeded that common naming conventions are followed. This field is mandatory.
Tags	This is used for documentation purposes. It represents the logical grouping of the operations, for example, by resource. An operation can have none or more tags. This field is optional.
Summary	This is a short description of the operation. This field is optional.
Description	This is used to give a more elaborate description of the operation. This field is optional.

Edit an Operation

You can edit an operation by using the Information capability on the operation instance page and navigating to the Master Data section. There you can use the Edit master data capability to the information of the operation. The information that can be edited is the follwoing: the tags, the summary and the description. Furthermore, it is also possible to set the deprecated flag which will automatically deprecate your operation.

Delete an Operation

You can delete an operation by navigating to the details view by clicking from the operation instance page and using the Delete capability.

You will need to confirm the action before the selected command is permanately deleted.

Managing Parameters of an operation

From an operation instance in the Parameters section it is possible to add a parameter by using the Add capability.

Inline are the parameters that are created from scratch with referring to a exiting or new, reuseable schema.

Inline parameters are defined using the following master data:


Property	Description
Name	This is the name of the parameter. For path parameters the name must be identical to the parameter as defined in the path. This field is mandatory.
Location	This is a flag representing whether the parameter is located in the path or in the query of a path. This field is mandatory.
Schema	This is a list of the primitive schema types that have already been created. The one chosen will be the schema type of the parameter that has being created. A new schema can be created while typing in the dropdown and choosing ADD. This field is mandatory.
Required	This is a Boolean. If it is checked then the property is required, otherwise it is optional.
Description	This is used to give a longer description of the error that occured. This field is optional.

Referenced parameters are a list of all the parameters that have already been created and are visible in the parameters overview page. You can choose one or more and add them to a specific operation

Managing Request Bodies of an operation

Not possible for GET and DELETE

From an operation instance page in the Request Body section it is possible to add a request body by using the Add capability.

Inline request body is defined by using the following master data:


Property	Description
Required	This is a Boolean. If it is checked then the property is required, otherwise it is optional.
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.
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 request body that s being created. This field is mandatory.
Description	This is used to give a longer description of the request body. This field is optional.

Referenced request bodies are a list of all the request bodies that have already been created and are visible in the Request Bodies overview page. You can choose one referenced request body and add it to a specific operation.

Managing Responses of an operation

From an operation instance page in the Responses section it is possible to add a response by using the Add capability.

Inline response is defined by using the following master data:


Property	Description
Status	The status of a response expresses the type of the response (e.g error, success etc.). The possible values are integers between 100 and 600 (including). 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.
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 is being created. This field is optional.
Description	This is used to give a longer description of the error that occured. This field is mandatory.

Referenced responses are a list of all the responses that have already been created and are visible in the Responses overview page. You can choose one and assign a status to it and add it to a specific operation.

Edit the documentation of an operation

The documentation is used to provide further information regarding the implementation of the operation. There are three sections used to organize the documentation, and these are the precondition(s), the operation logic/flow and the postconditions(s).