batchNotification.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "batchNotification",
  "description": "An notification about a batch status change\n(C) Copyright IBM Corp. 2020\nSPDX-License-Identifier: Apache-2.0",
  "$comment": "(C) Copyright IBM Corp. 2020; SPDX-License-Identifier: Apache-2.0",
  "examples": [
    {
      "id" : "1234",
      "name": "batch-2019-10-07",
      "integratorId": "c857cb05-b7f3-123b-bab9-bfc8151f5522",
      "topic" : "ingest.1.fhir.in",
      "dataType" : "claims",
      "invalidThreshold" : 10,
      "status" : "started",
      "startDate" : "2019-10-30T12:34:00Z",
      "metadata" : { "compression": "gzip" }
    },
    {
      "id" : "1234",
      "name": "batch-2019-10-07",
      "integratorId": "c857cb05-b7f3-123b-bab9-bfc8151f5522",
      "topic" : "ingest.1.fhir.in",
      "dataType" : "claims",
      "status" : "completed",
      "recordCount" : 100,
      "expectedRecordCount" : 100,
      "actualRecordCount" : 100,
      "invalidThreshold" : 10,
      "invalidRecordCount" : 4,
      "startDate" : "2019-10-30T12:34:00Z",
      "endDate" : "2019-10-30T16:02:00Z"
    }
  ],
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier for a batch",
      "type": "string"
    },
    "name": {
      "description": "Name of the batch",
      "type": "string"
    },
    "integratorId": {
      "description": "The unique identifier of the Data Integrator that created this batch",
      "type": "string"
    },
    "topic": {
      "description": "Name of the topic",
      "type": "string"
    },
    "dataType": {
      "description": "The type of data",
      "type": "string"
    },
    "status": {
      "description": "The new batch status",
      "type": "string",
      "enum": ["started", "sendCompleted", "completed", "terminated", "failed"]
    },
    "startDate": {
      "description": "The datetime the batch started, ISO 8601",
      "type": "string",
      "format": "date-time",
      "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ssXXX"
    },
    "endDate": {
      "description": "The datetime the batch completed, ISO 8601",
      "type": "string",
      "format": "date-time",
      "customDateTimePattern": "yyyy-MM-dd'T'HH:mm:ssXXX"
    },
    "recordCount": {
      "description": "Deprecated - expectedRecordCount should be used instead",
      "type": "integer",
      "minimum": 1
    },
    "expectedRecordCount": {
      "description": "The number of expected records in this batch",
      "type": "integer",
      "minimum": 1
    },
    "actualRecordCount": {
      "description": "The number of actual records in this batch",
      "type": "integer",
      "minimum": 0
    },
    "invalidThreshold": {
      "description": "The number of invalid records required to fail a batch (-1 is infinite)",
      "type": "integer",
      "minimum": -1,
      "default": -1
    },
    "invalidRecordCount": {
      "description": "The number of invalid records in this batch",
      "type": "integer",
      "minimum": 0
    },
    "metadata": {
      "description": "Custom batch metadata in JSON format",
      "type": "object"
    },
    "failureMessage": {
      "description": "A failure message. Only populated when the Batch status is 'failed'",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "integratorId",
    "topic",
    "dataType",
    "status",
    "startDate",
    "invalidThreshold"
  ]
}