Otter · Schema

JobReference

The job reference.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
id string Unique identifier of the job.
status string The status of the job.
View JSON Schema on GitHub

JSON Schema

public-api-job-reference-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "JobReference",
  "description": "The job reference.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-job-reference-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the job.",
      "format": "uuid",
      "example": "c75d9460-5d48-423d-8d01-f825fd5b1672"
    },
    "status": {
      "type": "string",
      "description": "The status of the job.",
      "enum": [
        "PENDING",
        "FAILED",
        "SUCCESS",
        "UNKNOWN"
      ],
      "example": "PENDING"
    }
  }
}