Operation Object
Includes information about an operation supported by an API.
This object is used by the following operations:
- Operations that reference the Operations object
- Operations that reference the APIVisibilityScope object
- Operations that reference the ApiOperationPolicy object (in 2020.2.0 and later)
The properties included in the Operation object are listed below.
| Property | Type | Required | Description |
|---|---|---|---|
| Name | string | Required | The name of the operation. |
| Method | string | Required | The HTTP method for the operation: GET, PUT, POST, or DELETE. |
| Path | string | Required |
The parameterized path for the operation. For example, if the resource is pet the path might be /pet/{id}, where id is the instance of the pet resource. You can also further describe or constrain the parameter by using regular expressions in the following format: /pet/{id:[regex]} |
| InputContentType | string | Required | The content type (MIME type) valid for request messages for this operation. Multiple media types are comma-separated. |
| OutputContentType | string | Required | The content type (MIME type) valid for response messages for this operation. Multiple media types are comma-separated. |
| FaultContentType | string | Optional | The content type (MIME type) valid for fault response messages for this operation. Multiple media types are comma-separated. |
| Input | Input[ ] | Optional | Information about one or more valid input parameters for the operation, expressed as an array. |
| OperationKey | string | Optional | For internal use only: the operation key. |
| OAuthDetails | OperationOAuthDetails | Optional | Includes information about OAuth details applicable to a specific operation. |
| OperationResourceDetails | OperationResourceDetails | Optional | Contains details about operations associated with an API version and the scopes assigned to them, if operation-specific scope mapping is in use for the API version. |
| InterfaceQName | string | Optional | The QName for the API interface; a unique ID, for internal use only. |
| WsdlOperationName | string | Optional | The name of the operation as it is represented in the WSDL. |