BigCommerce · Schema

Job Response

Response for /GET Jobs by Id.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
data object The job for theme upload or download
meta object
View JSON Schema on GitHub

JSON Schema

bigcommerce-jobresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JobResponse",
  "title": "Job Response",
  "type": "object",
  "properties": {
    "data": {
      "description": "The job for theme upload or download",
      "type": "object",
      "title": "Job",
      "properties": {
        "errors": {
          "description": "The errors.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "error": {
                "description": "The error.",
                "type": "string"
              },
              "message": {
                "description": "The message.",
                "type": "string"
              }
            }
          }
        },
        "id": {
          "description": "The identifier.",
          "type": "string"
        },
        "percent_complete": {
          "description": "The percent complete.",
          "type": "number"
        },
        "result": {
          "description": "The result.",
          "type": "object",
          "additionalProperties": true,
          "properties": {}
        },
        "status": {
          "type": "string",
          "description": "The status.",
          "enum": [
            "COMPLETED",
            "QUEUED",
            "WORKING",
            "FAILED"
          ]
        },
        "time": {
          "type": "string",
          "description": "The time.",
          "format": "date-time"
        },
        "warnings": {
          "description": "The warnings.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "description": "The message.",
                "type": "string"
              },
              "warning": {
                "description": "The warning.",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/OpenMeta"
    }
  },
  "description": "Response for /GET Jobs by Id.",
  "x-internal": false
}