API Operation Record Model
Defines the configuration for a single API operation, including SOAP-to-REST mapping, timeout, retries, callback settings, and execution mode.
Overview
The OperationRecord is a data structure that represents the complete configuration for a single operation within a service version. It defines the mapping between an inbound SOAP request and a corresponding REST endpoint, along with behavioral parameters that control its execution at runtime.
Each record contains identifiers, SOAP and REST mapping details, operational toggles like enabled and debugEnabled, and parameters for timeout, retries, and asynchronous callbacks. API publishers configure these records to control how the platform handles each specific operation.
Callback Secret Handling
A key security feature of the operation model is the handling of the callback secret. The secret itself is write-only to protect its value.
When an API publisher configures an operation, they may provide a secret via the callbackSecretRef field. This value is stored securely but is never exposed in any API response (such as on GET, LIST, or PATCH). Instead, API responses include a boolean field, callbackSecretSet, which is true if a secret is stored and false otherwise. This allows API consumers to verify that a secret is configured without ever seeing its value.
IMPORTANT
When updating an operation via a PATCH request, omitting the callbackSecretRef field or setting it to a blank value will not clear a previously stored secret. The platform is designed to retain the existing secret in this scenario to prevent accidental deletion. To change or clear a secret, an explicit new value or an empty string must be provided through the appropriate mechanism, if supported by the API.
Operation Record Fields
The following table describes the fields that constitute an OperationRecord.
| Field | Type | Default | Required | Description |
|---|---|---|---|---|
id | UUID | — | — | The unique identifier for the operation record. |
serviceVersionId | UUID | — | — | The unique identifier of the service version this operation belongs to. |
operationKey | String | — | — | A unique key for the operation within its service version. |
soapOperationName | String | — | — | The name of the SOAP operation as defined in the WSDL. |
soapAction | String | — | — | The value of the SOAPAction HTTP header associated with the operation. |
restMethod | String | — | — | The HTTP method (e.g., GET, POST) for the corresponding REST endpoint. |
restPath | String | — | — | The path for the corresponding REST endpoint. |
enabled | boolean | — | — | If true, the operation is active and can be invoked. |
timeoutMs | integer | — | — | The timeout for the operation in milliseconds. |
retryCount | integer | — | — | The number of times to retry the operation upon failure. |
debugEnabled | boolean | — | — | If true, enables extended debugging or logging for this operation. |
executionMode | String | — | — | Defines the execution mode for the operation (e.g., synchronous, asynchronous). |
callbackPath | String | — | — | The path where an asynchronous callback should be sent. |
callbackAuthMode | String | — | — | The authentication mode for the asynchronous callback (e.g., SECRET, NONE). |
callbackSecretRef | String | — | — | Write-only. A reference to the secret used for callback authentication. This field is never returned in API responses. |
callbackSecretSet | boolean | — | — | Read-only. A derived field that is true if a callbackSecretRef is present and not blank. This field is returned in API responses instead of the secret itself. |
asyncAckHttpStatus | integer | — | — | The HTTP status code to return as an acknowledgment in asynchronous execution mode. |
createdAt | OffsetDateTime | — | — | The timestamp when the operation record was created. |
updatedAt | OffsetDateTime | — | — | The timestamp when the operation record was last updated. |