Batch

This page is generated from the exact OpenAPI component schema. It does not add undocumented validation or product behavior.

Download JSON Schema

Property	Required	Type	Description
`batchPublicId`	Yes	string	—
`messageId`	Yes	string	—
`messageType`	Yes	string	—
`deliveryVersion`	Yes	integer	—
`channel`	Yes	string	—
`status`	Yes	BatchStatus	—
`manifestSha256`	Yes	Sha256	—
`publicationEvidence`	Yes	composed	—
`counts`	Yes	object	—
`createdAt`	Yes	string	—
`updatedAt`	Yes	string	—
`completedAt`	Yes	string \| null	—

json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "batchPublicId",
    "messageId",
    "messageType",
    "deliveryVersion",
    "channel",
    "status",
    "manifestSha256",
    "publicationEvidence",
    "counts",
    "createdAt",
    "updatedAt",
    "completedAt"
  ],
  "properties": {
    "batchPublicId": {
      "type": "string",
      "format": "uuid"
    },
    "messageId": {
      "type": "string"
    },
    "messageType": {
      "type": "string",
      "enum": [
        "NEW_RELEASE",
        "METADATA_UPDATE",
        "ASSET_UPDATE",
        "DEAL_UPDATE",
        "TAKEDOWN"
      ]
    },
    "deliveryVersion": {
      "type": "integer",
      "minimum": 1
    },
    "channel": {
      "type": "string",
      "enum": [
        "STUDIO_SELF_SERVICE",
        "PARTNER_API",
        "PARTNER_BULK",
        "DDEX",
        "KASTY_INTERNAL",
        "UNKNOWN"
      ]
    },
    "status": {
      "$ref": "#/components/schemas/BatchStatus"
    },
    "manifestSha256": {
      "$ref": "#/components/schemas/Sha256"
    },
    "publicationEvidence": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/PublicationEvidenceSummary"
        },
        {
          "type": "null"
        }
      ]
    },
    "counts": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "total",
        "accepted",
        "failed"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "accepted": {
          "type": "integer",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}