Data Export Spring Configurations (v1)

getExportConfigs

Get a list of data export configurations

query Parameters
query
string

A query string to filter rules based on matching criteria in fields.

limit
integer
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "configs": [
    ],
  • "totalRecords": 0
}

postExportConfig

Add an export configuration

header Parameters
X-Okapi-Tenant
required
string
Request Body schema: application/json
required
id
string
type
required
string (ExportType)
Default: "BURSAR_FEES_FINES"
Enum: "CIRCULATION_LOG" "BURSAR_FEES_FINES" "BATCH_VOUCHER_EXPORT" "EDIFACT_ORDERS_EXPORT" "CLAIMS" "ORDERS_EXPORT" "INVOICE_EXPORT" "E_HOLDINGS" "AUTH_HEADINGS_UPDATES" "FAILED_LINKED_BIB_UPDATES"
configName
string

Configuration name

tenant
string

Tenant id

required
object (ExportTypeSpecificParameters)
object (bursarExportJob)

Bursar export job schema

object (VendorEdiOrdersExportConfig)
query
string <= 5000 characters

CQL query to be passed to the module which data is being exported. Use it to filter data.

object (EHoldingsExportConfig)
object (AuthorityControlExportConfig)
scheduleFrequency
integer

Number of time periods

schedulePeriod
required
string
Enum: "WEEK" "DAY" "HOUR" "NONE"

Time period for repeating job

scheduleTime
string

Time to run the job

weekDays
Array of strings
Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"

Day of week to run the job

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "CIRCULATION_LOG",
  • "configName": "string",
  • "tenant": "string",
  • "exportTypeSpecificParameters": {
    },
  • "scheduleFrequency": 0,
  • "schedulePeriod": "WEEK",
  • "scheduleTime": "string",
  • "weekDays": [
    ]
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

getConfigById

Get a export configuration by the export configuration ID

path Parameters
id
required
string

UUID of the export configuration

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "CIRCULATION_LOG",
  • "configName": "string",
  • "tenant": "string",
  • "exportTypeSpecificParameters": {
    },
  • "scheduleFrequency": 0,
  • "schedulePeriod": "WEEK",
  • "scheduleTime": "string",
  • "weekDays": [
    ]
}

putExportConfig

Change an export configuration

path Parameters
id
required
string
header Parameters
X-Okapi-Tenant
required
string
Request Body schema: application/json
required
id
string
type
required
string (ExportType)
Default: "BURSAR_FEES_FINES"
Enum: "CIRCULATION_LOG" "BURSAR_FEES_FINES" "BATCH_VOUCHER_EXPORT" "EDIFACT_ORDERS_EXPORT" "CLAIMS" "ORDERS_EXPORT" "INVOICE_EXPORT" "E_HOLDINGS" "AUTH_HEADINGS_UPDATES" "FAILED_LINKED_BIB_UPDATES"
configName
string

Configuration name

tenant
string

Tenant id

required
object (ExportTypeSpecificParameters)
object (bursarExportJob)

Bursar export job schema

object (VendorEdiOrdersExportConfig)
query
string <= 5000 characters

CQL query to be passed to the module which data is being exported. Use it to filter data.

object (EHoldingsExportConfig)
object (AuthorityControlExportConfig)
scheduleFrequency
integer

Number of time periods

schedulePeriod
required
string
Enum: "WEEK" "DAY" "HOUR" "NONE"

Time period for repeating job

scheduleTime
string

Time to run the job

weekDays
Array of strings
Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"

Day of week to run the job

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "CIRCULATION_LOG",
  • "configName": "string",
  • "tenant": "string",
  • "exportTypeSpecificParameters": {
    },
  • "scheduleFrequency": 0,
  • "schedulePeriod": "WEEK",
  • "scheduleTime": "string",
  • "weekDays": [
    ]
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

deleteExportConfigById

Delete export configuration by UUID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

executeExportConfig

Run an export configuration immediately for the given records, ignoring the automatic export flags. Only Ordering EDIFACT orders export configurations are supported.

path Parameters
id
required
string

UUID of the export configuration

Request Body schema: application/json
required
poLineIds
required
Array of strings non-empty

PO line ids to export, ignoring the automatic export flags

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "jobId": "string"
}

getEffectiveConfigs

Get the configurations of an export type and vendor that apply to the config criteria, sorted by configName. For EDIFACT_ORDERS_EXPORT, an absent acquisitionMethod matches no configuration, an absent vendorAccount applies no account filter, and an empty vendorAccount means no account number. For CLAIMS, vendorAccount is ignored and an absent acquisitionMethod returns all configurations of the vendor; with one, configurations that select it match, and those without selected methods match if no other selects it. The result depends on all configurations of the vendor, and totalRecords is the number of all matches. Without scheduled, matches are returned whether they have a schedule or not.

query Parameters
vendorId
required
string <uuid>

UUID of the order's vendor

acquisitionMethod
string <uuid>

UUID of the acquisition method. Without it, no EDIFACT_ORDERS_EXPORT configuration and every CLAIMS configuration matches

vendorAccount
string

The vendor account number. Absent applies no account filter, empty means no account number

type
required
string (effectiveConfigType)
Enum: "EDIFACT_ORDERS_EXPORT" "CLAIMS"

Export type of the configurations

transmissionMethod
string (transmissionMethod)
Enum: "FTP" "File download" "Email"

Return only matches with this transmission method

scheduled
boolean

true returns only matches that run on a schedule, false only matches that don't. CLAIMS configurations never run on a schedule.

Responses

Response samples

Content type
application/json
{
  • "configs": [
    ],
  • "totalRecords": 0
}