API docs by Redocly

Inventory import API (v1.0)

getImportConfigs

Get import configuration records

query Parameters
offset
string

result set start row

limit
string

result set max rows

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "importConfigs": [
    ]
}

postImportConfig

Create import configuration

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
required
id
string

Unique identifier (UUID) for the configuration.

name
string

A name for the configuration.

type
string

DEPRECATED They type of import job, only bulk XML supported.

url
string

OBSOLETE, IGNORED The URL(s) used for retrieving the source records.

allowErrors
boolean

OBSOLETE, IGNORED.

recordLimit
integer

NOT IMPLEMENTED.

transformationId
string

UUID referencing the transformation pipeline to use.

storageId
string

OBSOLETE, IGNORED. Storage is always present FOLIO inventory.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "url": "string",
  • "allowErrors": true,
  • "recordLimit": 0,
  • "transformationId": "string",
  • "storageId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "url": "string",
  • "allowErrors": true,
  • "recordLimit": 0,
  • "transformationId": "string",
  • "storageId": "string"
}

getImportConfig

Get import configuration record

path Parameters
id
required
string

Import configuration identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "url": "string",
  • "allowErrors": true,
  • "recordLimit": 0,
  • "transformationId": "string",
  • "storageId": "string"
}

putImportConfig

Update an import configuration

path Parameters
id
required
string

Import configuration identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
id
string

Unique identifier (UUID) for the configuration.

name
string

A name for the configuration.

type
string

DEPRECATED They type of import job, only bulk XML supported.

url
string

OBSOLETE, IGNORED The URL(s) used for retrieving the source records.

allowErrors
boolean

OBSOLETE, IGNORED.

recordLimit
integer

NOT IMPLEMENTED.

transformationId
string

UUID referencing the transformation pipeline to use.

storageId
string

OBSOLETE, IGNORED. Storage is always present FOLIO inventory.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "url": "string",
  • "allowErrors": true,
  • "recordLimit": 0,
  • "transformationId": "string",
  • "storageId": "string"
}

Response samples

Content type
No sample

deleteImportConfig

Delete an import configuration

path Parameters
id
required
string

Import configuration identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

importXmlRecords

Load XML document using given import configuration

path Parameters
id
required
string

Import configuration identifier (UUID)

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: text/plain
string

Responses

Response samples

Content type
No sample

startFileListener

start verticle for given config ID that listens for incoming source records

path Parameters
id
required
string

Import configuration identifier (UUID)

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
No sample

pauseImport

stop file listening for given config ID

path Parameters
id
required
string

Import configuration identifier (UUID)

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
No sample

resumeImport

resume file listening for given config ID

path Parameters
id
required
string

Import configuration identifier (UUID)

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
No sample

postImportJob

Create job log samples for test purposes etc, for example by import from another FOLIO instance.

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
required
id
string

Unique identifier (UUID) for the import job report.

importConfigName
string

The name of the import configuration at the time of logging the import job.

importConfigId
string

UUID referencing the import configuration that defined the import job run.

importType
string

Type of import job (obsolete, always bulk XML).

recordLimit
integer

Not supported. Would indicates the limit -- if any -- on the maximum number of records to load according to the configuration.

transformation
string

Then name for the transformation pipeline used for the job.

status
string

The intermittent state of final outcome of the job.

started
string

Timestamp when the job started.

finished
string

Timestamp when the job ended.

amountHarvested
integer

The number of incoming records processed.

message
string

A description of the outcome of the import.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "importConfigName": "string",
  • "importConfigId": "string",
  • "importType": "string",
  • "recordLimit": 0,
  • "transformation": "string",
  • "status": "string",
  • "started": "string",
  • "finished": "string",
  • "amountHarvested": 0,
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "importConfigName": "string",
  • "importConfigId": "string",
  • "importType": "string",
  • "recordLimit": 0,
  • "transformation": "string",
  • "status": "string",
  • "started": "string",
  • "finished": "string",
  • "amountHarvested": 0,
  • "message": "string"
}

getImportJobs

Retrieves list of past import jobs

query Parameters
offset
integer

result set start row

limit
integer

result set max rows

from
string

date range start parameter on finished date

until
string

date range end parameter on finished date

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "importJobs": [
    ]
}

getImportJob

Retrieves details of a previous import job

path Parameters
id
required
string <uuid>

Import job identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "importConfigName": "string",
  • "importConfigId": "string",
  • "importType": "string",
  • "recordLimit": 0,
  • "transformation": "string",
  • "status": "string",
  • "started": "string",
  • "finished": "string",
  • "amountHarvested": 0,
  • "message": "string"
}

deleteImportJob

Delete a past import job with all its logs

path Parameters
id
required
string <uuid>

Import job identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
No sample

getImportJobLogLines

Retrieves the log of a past import job

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
No sample

postImportJobLogLines

For importing job logs from another source.

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
required
Array of objects (logLine)

Collection of Log4J log statements.

Array
id
string

Unique identifier (UUID) for the log line.

importJobId
string

UUID referencing the import job that generated the log.

timeStamp
string

Date and time the log statement was created.

jobLabel
string

Harvester's identification of the job that created the log line.

line
string

The logged statement.

Responses

Request samples

Content type
application/json
{
  • "logLines": [
    ]
}

Response samples

Content type
No sample

getFailedRecordsForJob

Retrieves the failed records of an import job

path Parameters
id
required
string <uuid>

Import job identifier

query Parameters
from
string

date range parameter on error report timestamp

until
string

date range parameter on error report timestamp

offset
integer

result set start row

limit
integer

result set max rows

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "failedRecords": [
    ]
}

postFailedRecordsForJob

Create failed record samples without running a job, for example to import from another FOLIO instance.

path Parameters
id
required
string <uuid>

Import job identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
required
Array of objects (failedRecord)

Array of failed record reports

Array
id
string

Unique ID (UUID) for the error report.

importJobId
string

UUID referencing the import job generation the report.

Array of objects

List of errors encountered during upsert or delete.

originalRecord
string

The original source record as plain text.

transformedRecord
object

The JSON outcome of the transformation of the original record.

timeStamp
string

The date and time the error occurred.

recordNumber
string

The identifier assigned to this error report by Inventory Import.

Responses

Request samples

Content type
application/json
{
  • "failedRecords": [
    ]
}

Response samples

Content type
No sample

deleteRecordFailure

Delete a past import job with all its logs

path Parameters
id
required
string <uuid>

Failed record identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
No sample

getSteps

Get step records

query Parameters
offset
string

result set start row

limit
string

result set max rows

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "steps": [
    ]
}

postStep

Create step

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
required
id
string

Unique identifier (UUID) for the transformation step.

name
required
string

A name assigned to the transformation step.

enabled
boolean
Default: false

Indicates if this step is available to be used in a transformation pipeline.

description
string

Free text details about the step.

type
string
Enum: "XmlTransformStep" "CustomTransformStep"

The type of transformation step.

inputFormat
string

Free-text indication of the format of input data to the step.

outputFormat
string

Free-text indication of the format of the resulting output from the step.

script
string

The transformation script (XSLT) of the step.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enabled": false,
  • "description": "string",
  • "type": "XmlTransformStep",
  • "inputFormat": "string",
  • "outputFormat": "string",
  • "script": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enabled": false,
  • "description": "string",
  • "type": "XmlTransformStep",
  • "inputFormat": "string",
  • "outputFormat": "string",
  • "script": "string"
}

getStep

Get detailed transformation step definition record

path Parameters
id
required
string

Step identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enabled": false,
  • "description": "string",
  • "type": "XmlTransformStep",
  • "inputFormat": "string",
  • "outputFormat": "string",
  • "script": "string"
}

putStep

Update a transformation step definition

path Parameters
id
required
string

Step identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
id
string

Unique identifier (UUID) for the transformation step.

name
required
string

A name assigned to the transformation step.

enabled
boolean
Default: false

Indicates if this step is available to be used in a transformation pipeline.

description
string

Free text details about the step.

type
string
Enum: "XmlTransformStep" "CustomTransformStep"

The type of transformation step.

inputFormat
string

Free-text indication of the format of input data to the step.

outputFormat
string

Free-text indication of the format of the resulting output from the step.

script
string

The transformation script (XSLT) of the step.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enabled": false,
  • "description": "string",
  • "type": "XmlTransformStep",
  • "inputFormat": "string",
  • "outputFormat": "string",
  • "script": "string"
}

Response samples

Content type
No sample

deleteStep

Delete a transformation step definition

path Parameters
id
required
string

Step identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

getScript

Get transformation step script

path Parameters
id
required
string

Step identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

putScript

Update a transformation step script

path Parameters
id
required
string

Step identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: text/plain
string

Responses

Response samples

Content type
No sample

getTransformations

Get transformation definitions

query Parameters
offset
integer

result set start row

limit
integer

result set max rows

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "transformations": [
    ]
}

postTransformation

Create transformation pipeline

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
required
id
string

Unique identifier (UUID) for the transformation pipeline.

name
string

Name of the transformation pipeline.

description
string

Free-text details about the pipeline.

enabled
string
Enum: "true" "false"

"Indicates if the transformation pipeline can be used by import jobs."

Array of objects

The transformation steps making up this pipeline, in order of execution.

Array
id
required
string

The ID (UUID) of the step at this position in the transformation pipeline.

name
string

The (unique) name of the step.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "enabled": "true",
  • "steps": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "enabled": "true",
  • "steps": [
    ]
}

getTransformation

Get transformation pipeline record

path Parameters
id
required
string

Transformation pipeline identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "enabled": "true",
  • "steps": [
    ]
}

putTransformation

Update a transformation pipeline

path Parameters
id
required
string

Transformation pipeline identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
id
string

Unique identifier (UUID) for the transformation pipeline.

name
string

Name of the transformation pipeline.

description
string

Free-text details about the pipeline.

enabled
string
Enum: "true" "false"

"Indicates if the transformation pipeline can be used by import jobs."

Array of objects

The transformation steps making up this pipeline, in order of execution.

Array
id
required
string

The ID (UUID) of the step at this position in the transformation pipeline.

name
string

The (unique) name of the step.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "enabled": "true",
  • "steps": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "enabled": "true",
  • "steps": [
    ]
}

deleteTransformation

Delete a transformation pipeline

path Parameters
id
required
string

Transformation pipeline identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

getTsas

Get transformation step associations

query Parameters
offset
integer

result set start row

limit
integer

result set max rows

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "transformationSteps": [
    ]
}

postTsa

Create new transformation step association

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
Any of
id
string

Unique identifier (UUID) for the association.

stepId
required
string

UUID referencing a transformation step.

transformationId
required
string

UUID referencing a transformation pipeline.

position
required
string

The position of the step amongst other steps in the pipeline.

object

DEPRECATED, legacy Harvester schema for identifying step

id
string

Id of the step associated with a pipeline.

name
string

Name for the step associated with a pipeline.

property name*
additional property
any
transformation
string

DEPRECATED, legacy Harvester schema for identifying transformation pipeline.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "stepId": "string",
  • "transformationId": "string",
  • "position": "string",
  • "step": {
    },
  • "transformation": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "stepId": "string",
  • "transformationId": "string",
  • "position": "string",
  • "step": {
    },
  • "transformation": "string"
}

deleteTsas

Delete all transformation step associations

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

getTsa

Get a transformation step association by ID

path Parameters
id
required
string

Association identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "stepId": "string",
  • "transformationId": "string",
  • "position": "string",
  • "step": {
    },
  • "transformation": "string"
}

putTsa

Update a transformation step association

path Parameters
id
required
string

Association identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
Any of
id
string

Unique identifier (UUID) for the association.

stepId
required
string

UUID referencing a transformation step.

transformationId
required
string

UUID referencing a transformation pipeline.

position
required
string

The position of the step amongst other steps in the pipeline.

object

DEPRECATED, legacy Harvester schema for identifying step

id
string

Id of the step associated with a pipeline.

name
string

Name for the step associated with a pipeline.

property name*
additional property
any
transformation
string

DEPRECATED, legacy Harvester schema for identifying transformation pipeline.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "stepId": "string",
  • "transformationId": "string",
  • "position": "string",
  • "step": {
    },
  • "transformation": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "stepId": "string",
  • "transformationId": "string",
  • "position": "string",
  • "step": {
    },
  • "transformation": "string"
}

deleteTsa

Delete a transformation step association by ID

path Parameters
id
required
string

Association identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

purgeAgedLogs

Delete old import job logs from storage

Responses