Iterate instances version v1.0

http://localhost

Instance iteration

Iterate instances by generating domain events for them

Iterate instances

post

post

Submit an iteration job

Submit an iteration job

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Iteration job parameters",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.IterationJobParams",
  "properties": {
    "eventType": {
      "description": "Type of events to be published",
      "type": "string",
      "default": "ITERATE"
    },
    "topicName": {
      "description": "Name of Kafka topic to publish events to",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "topicName"
  ]
}

HTTP status code 201

Iteration job has been submitted

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Iteration job",
  "type": "object",
  "properties": {
    "id": {
      "description": "Job id",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "messagesPublished": {
      "description": "Number of messages that was published so far",
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "jobStatus": {
      "description": "Overall job status",
      "type": "string",
      "enum": [
        "In progress",
        "Failed",
        "Completed",
        "Cancellation pending",
        "Cancelled"
      ]
    },
    "submittedDate": {
      "description": "Timestamp when the job has been submitted",
      "type": "string",
      "format": "date-time"
    },
    "jobParams": {
      "description": "Job parameters",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.IterationJobParams",
      "properties": {
        "eventType": {
          "description": "Type of events to be published",
          "type": "string",
          "default": "ITERATE"
        },
        "topicName": {
          "description": "Name of Kafka topic to publish events to",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "topicName"
      ]
    }
  },
  "additionalProperties": false
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

get delete

get

Get iteration job by id

delete

Cancel iteration job by id

Get iteration job by id

URI Parameters

  • id: required(string)

HTTP status code 200

Iteration job has returned

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Iteration job",
  "type": "object",
  "properties": {
    "id": {
      "description": "Job id",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "messagesPublished": {
      "description": "Number of messages that was published so far",
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "jobStatus": {
      "description": "Overall job status",
      "type": "string",
      "enum": [
        "In progress",
        "Failed",
        "Completed",
        "Cancellation pending",
        "Cancelled"
      ]
    },
    "submittedDate": {
      "description": "Timestamp when the job has been submitted",
      "type": "string",
      "format": "date-time"
    },
    "jobParams": {
      "description": "Job parameters",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.IterationJobParams",
      "properties": {
        "eventType": {
          "description": "Type of events to be published",
          "type": "string",
          "default": "ITERATE"
        },
        "topicName": {
          "description": "Name of Kafka topic to publish events to",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "topicName"
      ]
    }
  },
  "additionalProperties": false
}

HTTP status code 404

Iteration job with id not found

Body

Media type: text/plain

Type: any

Example:

Not found

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

Cancel iteration job by id

URI Parameters

  • id: required(string)

HTTP status code 204

Iteration job has been cancelled

HTTP status code 404

Iteration job with id not found

Body

Media type: text/plain

Type: any

Example:

Not found

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error