foliolib.folio.api.dataExportSpring.Exportconfigs

class foliolib.folio.api.dataExportSpring.Exportconfigs(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Data Export Spring Configurations

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`deleteexportconfigbyid`(id_)	Delete export configuration by UUID
`getconfigbyid`(id_)	Get a export configuration by the export configuration ID
`getexportconfigs`(**kwargs)	Get a list of data export configurations
`postexportconfig`(exportConfig)	Add an export configuration
`putexportconfig`(exportConfig, id_)	Change an export configuration

deleteexportconfigbyid(id_)

Delete export configuration by UUID

DELETE /data-export-spring/configs/{id}

Raises

OkapiRequestError – Bad request
OkapiRequestNotFound – Export config not found
OkapiFatalError – Internal server errors, e.g. due to misconfiguration

getconfigbyid(id_)

Get a export configuration by the export configuration ID

GET /data-export-spring/configs/{id}

Returns

See Schema below.

Return type

dict

Raises

OkapiRequestError – Bad request, e.g. malformed request body or query parameter. Details of the errors (e.g. name of the parameter or line/character number with malformed data) provided in the response.
OkapiRequestNotFound – Export configuration with a given ID not found
OkapiFatalError – Internal server errors, e.g. due to misconfiguration

Schema

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "description": "Export type",
            "$ref": "exportType.json#/ExportType"
        },
        "tenant": {
            "description": "Tenant id",
            "type": "string"
        },
        "exportTypeSpecificParameters": {
            "$ref": "exportTypeSpecificParameters.json#/ExportTypeSpecificParameters"
        },
        "scheduleFrequency": {
            "type": "integer",
            "description": "Number of time periods"
        },
        "schedulePeriod": {
            "type": "string",
            "description": "Time period for repeating job",
            "enum": [
                "WEEK",
                "DAY",
                "HOUR",
                "NONE"
            ]
        },
        "scheduleTime": {
            "type": "string",
            "description": "Time to run the job"
        },
        "weekDays": {
            "type": "array",
            "description": "Day of week to run the job",
            "items": {
                "type": "string",
                "description": "Day of week",
                "enum": [
                    "MONDAY",
                    "TUESDAY",
                    "WEDNESDAY",
                    "THURSDAY",
                    "FRIDAY",
                    "SATURDAY",
                    "SUNDAY"
                ]
            }
        }
    },
    "additionalProperties": false,
    "required": [
        "type",
        "exportTypeSpecificParameters",
        "schedulePeriod"
    ]
}

getexportconfigs(**kwargs)

Get a list of data export configurations

GET /data-export-spring/configs

Keyword Arguments

query (str) – A query string to filter rules based on matching criteria in fields.
limit (int) – Limit the number of elements returned in the response (default: 10)

Returns

See Schema below.

Return type

dict

Raises

OkapiFatalError – Internal server errors, e.g. due to misconfiguration

Schema

{
    "type": "object",
    "properties": {
        "configs": {
            "description": "List of configs",
            "type": "array",
            "items": {
                "$ref": "exportConfig.json#/ExportConfig"
            }
        },
        "totalRecords": {
            "type": "integer"
        }
    },
    "additionalProperties": false,
    "required": [
        "configs",
        "totalRecords"
    ]
}

postexportconfig(exportConfig)

Add an export configuration

POST /data-export-spring/configs

Parameters

exportConfig (dict) – See Schema below.

Raises

OkapiRequestError – Bad request
OkapiFatalError – Internal server errors, e.g. due to misconfiguration

Schema

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "description": "Export type",
            "$ref": "exportType.json#/ExportType"
        },
        "tenant": {
            "description": "Tenant id",
            "type": "string"
        },
        "exportTypeSpecificParameters": {
            "$ref": "exportTypeSpecificParameters.json#/ExportTypeSpecificParameters"
        },
        "scheduleFrequency": {
            "type": "integer",
            "description": "Number of time periods"
        },
        "schedulePeriod": {
            "type": "string",
            "description": "Time period for repeating job",
            "enum": [
                "WEEK",
                "DAY",
                "HOUR",
                "NONE"
            ]
        },
        "scheduleTime": {
            "type": "string",
            "description": "Time to run the job"
        },
        "weekDays": {
            "type": "array",
            "description": "Day of week to run the job",
            "items": {
                "type": "string",
                "description": "Day of week",
                "enum": [
                    "MONDAY",
                    "TUESDAY",
                    "WEDNESDAY",
                    "THURSDAY",
                    "FRIDAY",
                    "SATURDAY",
                    "SUNDAY"
                ]
            }
        }
    },
    "additionalProperties": false,
    "required": [
        "type",
        "exportTypeSpecificParameters",
        "schedulePeriod"
    ]
}

putexportconfig(exportConfig, id_)

Change an export configuration

PUT /data-export-spring/configs/{id}

Parameters

exportConfig (dict) – See Schema below.

Raises

OkapiRequestError – Bad request
OkapiRequestNotFound – Export config not found
OkapiFatalError – Internal server errors, e.g. due to misconfiguration

Schema

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "description": "Export type",
            "$ref": "exportType.json#/ExportType"
        },
        "tenant": {
            "description": "Tenant id",
            "type": "string"
        },
        "exportTypeSpecificParameters": {
            "$ref": "exportTypeSpecificParameters.json#/ExportTypeSpecificParameters"
        },
        "scheduleFrequency": {
            "type": "integer",
            "description": "Number of time periods"
        },
        "schedulePeriod": {
            "type": "string",
            "description": "Time period for repeating job",
            "enum": [
                "WEEK",
                "DAY",
                "HOUR",
                "NONE"
            ]
        },
        "scheduleTime": {
            "type": "string",
            "description": "Time to run the job"
        },
        "weekDays": {
            "type": "array",
            "description": "Day of week to run the job",
            "items": {
                "type": "string",
                "description": "Day of week",
                "enum": [
                    "MONDAY",
                    "TUESDAY",
                    "WEDNESDAY",
                    "THURSDAY",
                    "FRIDAY",
                    "SATURDAY",
                    "SUNDAY"
                ]
            }
        }
    },
    "additionalProperties": false,
    "required": [
        "type",
        "exportTypeSpecificParameters",
        "schedulePeriod"
    ]
}