foliolib.folio.api.dataExport.DataExportTransformationFields

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

Bases: foliolib.folio.FolioApi

Data export transformation fields API

API for getting transformation fields

Parameters

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

Methods

get_transformationFields()

Retrieve transformationField item with given {transformationFieldId}

get_transformationFields()

Retrieve transformationField item with given {transformationFieldId}

GET /data-export/transformation-fields

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of transformation fields",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "transformationFields": {
      "description": "List of transformation fields",
      "type": "array",
      "id": "transformationFieldsList",
      "items": {
        "type": "object",
        "$ref": "transformationField.json"
      }
    },
    "totalRecords": {
      "description": "Total number of transformation fields",
      "type": "integer"
    }
  },
  "required": [
    "transformationFields",
    "totalRecords"
  ]
}