http://localhost
Iterate instances by generating domain events for them
Submit an iteration job
POST /instance-storage/instances/iteration
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"
]
}
Iteration job has been submitted
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
}
Internal server error
Media type: text/plain
Type: any
Example:
Internal server error
Get iteration job by id
GET /instance-storage/instances/iteration/{id}
Iteration job has returned
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
}
Iteration job with id not found
Media type: text/plain
Type: any
Example:
Not found
Internal server error
Media type: text/plain
Type: any
Example:
Internal server error
Cancel iteration job by id
DELETE /instance-storage/instances/iteration/{id}