Apigee · Schema

Operation

A long-running operation.

Advanced API SecurityAgentic AIAnalyticsAPI GatewayAPI GovernanceAPI HubAPI ManagementDeveloper PortalEnterpriseGenerative AIHybridIntegrationsMicroservicesMCPModel Context ProtocolMonetization

Properties

Name Type Description
name string Name of the operation resource.
metadata object Service-specific metadata.
done boolean Whether the operation is complete.
error object
response object The normal response of the operation.
View JSON Schema on GitHub

JSON Schema

apigee-operation-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Operation",
  "title": "Operation",
  "type": "object",
  "description": "A long-running operation.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the operation resource."
    },
    "metadata": {
      "type": "object",
      "description": "Service-specific metadata.",
      "additionalProperties": true
    },
    "done": {
      "type": "boolean",
      "description": "Whether the operation is complete."
    },
    "error": {
      "$ref": "#/components/schemas/Status"
    },
    "response": {
      "type": "object",
      "description": "The normal response of the operation.",
      "additionalProperties": true
    }
  }
}