Represents an API operation inside the designer editor and agent model.
Document| Property | Type | Description |
|---|---|---|
| arguments | Operation_Argument | Ordered list of non-body input parameters (path, query, header) provided to this operation. |
| description | Text | Plain text summary explaining the purpose and behavior of this operation. |
| httpCode | Text | Default HTTP response status code for a successful request (e.g., '200', '201'). Defaults to '200' if omitted. |
| httpMethod | Text | The HTTP method for this endpoint. Must be an uppercase verb: 'GET', 'POST', 'PUT', 'DELETE', 'PATCH', or 'HEAD'. |
| httpPath | Text | The relative URL path of the endpoint. Path variables must be prefixed with a colon (e.g., '/product/:id'). |
| name | Text | Unique identifier for the operation using dot-notation (e.g., 'product.getAll' or 'user.create'). |
| payload | Text | The type name used as the request body payload. Defines the request body for POST/PUT/PATCH requests. Omit or leave empty for operations that do not require a request body (e.g., GET requests). |
| return | Text | The return type name or primitive type returned upon successful operation completion. |
| throws | Operation_Throw | List of non-success error responses that this operation can return. |