foliolib.folio.api.kbEbscoJava.Uc

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

Bases: foliolib.folio.FolioApi

mod-kb-ebsco-java

Implements the eholdings interface using EBSCO KB as backend.

Parameters

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

Methods

`get_clientIds`()	Get Usage Consolidation client id
`get_clientSecrets`()	Get Usage Consolidation client secret
`get_key_by_kbCredential`(kbCredentialsId)	Retrieve a Usage Consolidation settings customer key.
`get_ucCredentials`()	Check if Usage Consolidation credentials exists.
`get_uc_by_kbCredential`(kbCredentialsId, **kwargs)	Retrieve a Usage Consolidation settings.
`get_ucs`(**kwargs)	Retrieve a Usage Consolidation settings.
`modify_ucCredential`(ucCredential)	Update Usage Consolidation credentials
`set_uc`(kbCredentialsId, uc)	Create a new Usage Consolidation Settings

get_clientIds()

Get Usage Consolidation client id

GET /eholdings/uc-credentials/clientId

Returns: See Schema below
Return type: str

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Credentials Client ID object schema",
  "description": "Usage Consolidation Credentials Client ID object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCCredentialsClientId",
  "additionalProperties": false,
  "properties": {
    "clientId": {
      "type": "string",
      "description": "Client ID",
      "example": "client-101"
    }
  },
  "required": [
    "clientId"
  ]
}

get_clientSecrets()

Get Usage Consolidation client secret

GET /eholdings/uc-credentials/clientSecret

Returns: See Schema below
Return type: str

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Credentials Client Secret object schema",
  "description": "Usage Consolidation Credentials Client Secret object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCCredentialsClientSecret",
  "additionalProperties": false,
  "properties": {
    "clientSecret": {
      "type": "string",
      "description": "Client API key",
      "example": "client-101-api-key"
    }
  },
  "required": [
    "clientSecret"
  ]
}

get_key_by_kbCredential(kbCredentialsId: str)

Retrieve a Usage Consolidation settings customer key.

GET /eholdings/kb-credentials/{kbCredentialsId}/uc/key

Parameters: kbCredentialsId (str) –
Returns: See Schema below
Return type: dict
Raises: OkapiRequestNotFound – Not Found

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Settings Customer Key object schema",
  "description": "Usage Consolidation Settings Customer Key object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCSettingsKey",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "ucSettingsKey"
      ],
      "example": "ucSettingsKey"
    },
    "attributes": {
      "type": "object",
      "description": "Usage Consolidation settings customer key attributes",
      "$ref": "uCSettingsKeyDataAttributes.json"
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

get_ucCredentials()

Check if Usage Consolidation credentials exists.

GET /eholdings/uc-credentials

Returns: See Schema below
Return type: dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Credentials Presence object schema",
  "description": "Usage Consolidation Credentials Presence object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCCredentialsPresence",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "ucCredentialsPresence"
      ],
      "example": "ucCredentialsPresence"
    },
    "attributes": {
      "type": "object",
      "description": "Usage Consolidation credentials presence attributes",
      "javaType": "org.folio.rest.jaxrs.model.UCCredentialsPresenceAttributes",
      "additionalProperties": false,
      "properties": {
        "isPresent": {
          "type": "boolean",
          "description": "Indicates that Usage Consolidation credentials exist in the system",
          "example": true
        }
      },
      "required": [
        "isPresent"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

get_uc_by_kbCredential(kbCredentialsId: str, **kwargs)

Retrieve a Usage Consolidation settings.

GET /eholdings/kb-credentials/{kbCredentialsId}/uc

Parameters

kbCredentialsId (str) –
**kwargs (properties) – Keyword Arguments

Keyword Arguments

metrictype (bool) – (default=False) Indicates that metric type should be included

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Settings object schema",
  "description": "Usage Consolidation Settings object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCSettings",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "ucSettings"
      ],
      "example": "ucSettings"
    },
    "attributes": {
      "type": "object",
      "description": "Usage Consolidation settings attributes",
      "$ref": "uCSettingsDataAttributes.json"
    },
    "meta": {
      "type": "object",
      "description": "Metadata about creation and changes to item",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

get_ucs(**kwargs)

Retrieve a Usage Consolidation settings.

GET /eholdings/uc

Parameters: **kwargs (properties) – Keyword Arguments
Keyword Arguments: metrictype (bool) – (default=False) Indicates that metric type should be included
Returns: See Schema below
Return type: dict
Raises: OkapiRequestNotFound – Not Found

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Settings object schema",
  "description": "Usage Consolidation Settings object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCSettings",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "ucSettings"
      ],
      "example": "ucSettings"
    },
    "attributes": {
      "type": "object",
      "description": "Usage Consolidation settings attributes",
      "$ref": "uCSettingsDataAttributes.json"
    },
    "meta": {
      "type": "object",
      "description": "Metadata about creation and changes to item",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

modify_ucCredential(ucCredential: dict)

Update Usage Consolidation credentials

PUT /eholdings/uc-credentials

Parameters: ucCredential (dict) – See Schema below
Raises: OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Credentials object schema",
  "description": "Usage Consolidation Credentials object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCCredentials",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "ucCredentials"
      ],
      "example": "ucCredentials"
    },
    "attributes": {
      "type": "object",
      "description": "Usage Consolidation credentials attributes",
      "javaType": "org.folio.rest.jaxrs.model.UCCredentialsAttributes",
      "additionalProperties": false,
      "properties": {
        "clientId": {
          "type": "string",
          "description": "Client ID",
          "example": "client-101"
        },
        "clientSecret": {
          "type": "string",
          "description": "Client API key",
          "example": "client-101-api-key"
        }
      },
      "required": [
        "clientId",
        "clientSecret"
      ]
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

set_uc(kbCredentialsId: str, uc: dict)

Create a new Usage Consolidation Settings

POST /eholdings/kb-credentials/{kbCredentialsId}/uc

Parameters

kbCredentialsId (str) –
uc (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Settings Post Request object schema",
  "description": "Usage Consolidation Settings Post Request object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCSettingsPostRequest",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Usage Consolidation Post Request Settings attributes",
      "$ref": "uCSettingsPostDataAttributes.json"
    }
  },
  "required": [
    "data"
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Usage Consolidation Settings object schema",
  "description": "Usage Consolidation Settings object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.UCSettings",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "ucSettings"
      ],
      "example": "ucSettings"
    },
    "attributes": {
      "type": "object",
      "description": "Usage Consolidation settings attributes",
      "$ref": "uCSettingsDataAttributes.json"
    },
    "meta": {
      "type": "object",
      "description": "Metadata about creation and changes to item",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}