Ampersand · Schema

UpsertMetadataResponse

Response containing results for all created/updated fields

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
success boolean Indicates if the upsert operation was successful
fields object Maps object name -> field name -> upsert result
View JSON Schema on GitHub

JSON Schema

ampersand-api-upsert-metadata-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-upsert-metadata-response-schema.json",
  "title": "UpsertMetadataResponse",
  "description": "Response containing results for all created/updated fields",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Indicates if the upsert operation was successful"
    },
    "fields": {
      "type": "object",
      "description": "Maps object name -> field name -> upsert result",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/FieldUpsertResult"
        }
      }
    }
  },
  "required": [
    "success",
    "fields"
  ]
}