foliolib.folio.api.dataExport.DataExportJobProfile

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

Bases: foliolib.folio.FolioApi

Data export Job Profile API

APIs for creating job Profiles to manage export jobs

Parameters

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

Methods

`delete_jobProfile`(jobProfilesId)	Delete jobProfile item with given {jobProfileId}
`get_jobProfile`(jobProfilesId)	Retrieve jobProfile item with given {jobProfileId}
`get_jobProfiles`(**kwargs)	Retrieve a list of jobProfile items.
`modify_jobProfile`(jobProfilesId, jobProfile)	Update jobProfile item with given {jobProfileId}
`set_jobProfile`(jobProfile)	Create a new jobProfile item.

delete_jobProfile(jobProfilesId: str)

Delete jobProfile item with given {jobProfileId}

DELETE /data-export/job-profiles/{jobProfilesId}

Parameters

jobProfilesId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

get_jobProfile(jobProfilesId: str)

Retrieve jobProfile item with given {jobProfileId}

GET /data-export/job-profiles/{jobProfilesId}

Parameters

jobProfilesId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Job profile",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Unique identifier",
      "type": "string",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "name": {
      "description": "Job Profile name",
      "type": "string"
    },
    "default": {
      "description": "Is default job profile",
      "type": "boolean",
      "default": false,
      "readonly": true
    },
    "destination": {
      "description": "Final destination place where to send file",
      "type": "string"
    },
    "description": {
      "description": "Job Profile description",
      "type": "string"
    },
    "userInfo": {
      "description": "First name, last name and username of the user, who updated the Job Profile",
      "type": "object",
      "$ref": "userInfo.json"
    },
    "mappingProfileId": {
      "description": "Associated mapping profile id",
      "type": "string",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "protocol": {
      "description": "TCP/IP settings",
      "type": "object",
      "$ref": "protocol.json"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "mappingProfileId"
  ]
}

get_jobProfiles(**kwargs)

Retrieve a list of jobProfile items.

GET /data-export/job-profiles

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

with valid searchable fields

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- status=SUCCESS

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of Job Profiles",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "jobProfiles": {
      "description": "List of Job Profiles",
      "type": "array",
      "id": "jobProfileList",
      "items": {
        "type": "object",
        "$ref": "jobProfile.json"
      }
    },
    "totalRecords": {
      "description": "Total number of Job Profiles",
      "type": "integer"
    }
  },
  "required": [
    "jobProfiles",
    "totalRecords"
  ]
}

modify_jobProfile(jobProfilesId: str, jobProfile: dict)

Update jobProfile item with given {jobProfileId}

PUT /data-export/job-profiles/{jobProfilesId}

Parameters

jobProfilesId (str) –
jobProfile (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Job profile",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Unique identifier",
      "type": "string",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "name": {
      "description": "Job Profile name",
      "type": "string"
    },
    "default": {
      "description": "Is default job profile",
      "type": "boolean",
      "default": false,
      "readonly": true
    },
    "destination": {
      "description": "Final destination place where to send file",
      "type": "string"
    },
    "description": {
      "description": "Job Profile description",
      "type": "string"
    },
    "userInfo": {
      "description": "First name, last name and username of the user, who updated the Job Profile",
      "type": "object",
      "$ref": "userInfo.json"
    },
    "mappingProfileId": {
      "description": "Associated mapping profile id",
      "type": "string",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "protocol": {
      "description": "TCP/IP settings",
      "type": "object",
      "$ref": "protocol.json"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "mappingProfileId"
  ]
}

set_jobProfile(jobProfile: dict)

Create a new jobProfile item.

POST /data-export/job-profiles

Parameters

jobProfile (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created jobProfile item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Job profile",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Unique identifier",
      "type": "string",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "name": {
      "description": "Job Profile name",
      "type": "string"
    },
    "default": {
      "description": "Is default job profile",
      "type": "boolean",
      "default": false,
      "readonly": true
    },
    "destination": {
      "description": "Final destination place where to send file",
      "type": "string"
    },
    "description": {
      "description": "Job Profile description",
      "type": "string"
    },
    "userInfo": {
      "description": "First name, last name and username of the user, who updated the Job Profile",
      "type": "object",
      "$ref": "userInfo.json"
    },
    "mappingProfileId": {
      "description": "Associated mapping profile id",
      "type": "string",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "protocol": {
      "description": "TCP/IP settings",
      "type": "object",
      "$ref": "protocol.json"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "mappingProfileId"
  ]
}