foliolib.folio.api.dataImportConverterStorage.FormConfigsStorage

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

Bases: foliolib.folio.FolioApi

Forms Configs Storage API

API for accessing flexible forms configs

Parameters

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

Methods

`delete_config`(formName)	Delete config item with given {configId}
`get_config`(formName)	Retrieve config item with given {configId}
`get_configs`()	Retrieve a list of config items.
`modify_config`(formName, config)	Update config item with given {configId}
`set_config`(config)	Create new form config

delete_config(formName: str)

Delete config item with given {configId}

DELETE /converter-storage/forms/configs/{formName}

Parameters

formName (str) –

Raises

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

get_config(formName: str)

Retrieve config item with given {configId}

GET /converter-storage/forms/configs/{formName}

Parameters

formName (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": "Flexible form config",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "formName": {
      "description": "Name of corresponding form",
      "type": "string"
    },
    "config": {
      "description": "Form config content"
    }
  },
  "required": [
    "formName",
    "config"
  ]
}

get_configs()

Retrieve a list of config items.

GET /converter-storage/forms/configs

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of forms configs",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "formConfigs": {
      "description": "List of forms configs",
      "type": "array",
      "id": "formConfigList",
      "items": {
        "type": "object",
        "$ref": "./formConfig.json"
      }
    },
    "totalRecords": {
      "description": "Total number of forms configs",
      "type": "integer"
    }
  },
  "required": [
    "formConfigs",
    "totalRecords"
  ]
}

modify_config(formName: str, config: dict)

Update config item with given {configId}

PUT /converter-storage/forms/configs/{formName}

Parameters

formName (str) –
config (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Flexible form config",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "formName": {
      "description": "Name of corresponding form",
      "type": "string"
    },
    "config": {
      "description": "Form config content"
    }
  },
  "required": [
    "formName",
    "config"
  ]
}

set_config(config: dict)

Create new form config

POST /converter-storage/forms/configs

Parameters

config (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error

Headers

Location - URI to the created config item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Flexible form config",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "formName": {
      "description": "Name of corresponding form",
      "type": "string"
    },
    "config": {
      "description": "Form config content"
    }
  },
  "required": [
    "formName",
    "config"
  ]
}