Configuration and Administration

Ex Libris Developer Network Alma Documentation REST APIs Configuration and Administration

The Configuration API allows access to configuration related information, as described in the map below.

 

Alma provides a set of Web services for handling Configuration related information, enabling you to quickly and easily receive configuration details. These Web services can be used by external systems in order to get list of possible data.

Organization Units

APIPath
Retrieve Departments
GET /almaws/v1/conf/departments
Retrieve Libraries
GET /almaws/v1/conf/libraries
Retrieve Library
GET /almaws/v1/conf/libraries/{libraryCode}
Retrieve Locations
GET /almaws/v1/conf/libraries/{libraryCode}/locations
Retrieve Location
GET /almaws/v1/conf/libraries/{libraryCode}/locations/{locationCode}
Update a Location
PUT /almaws/v1/conf/libraries/{libraryCode}/locations/{locationCode}

General

APIPath
Retrieve Code-table
GET /almaws/v1/conf/code-tables/{codeTableName}
Retrieve General Configuration
GET /almaws/v1/conf/general
Retrieve Library Open Hours
GET /almaws/v1/conf/libraries/{libraryCode}/open-hours
Retrieve Open Hours
GET /almaws/v1/conf/open-hours

Jobs

APIPath
Retrieve Jobs
GET /almaws/v1/conf/jobs
Retrieve Job Details
GET /almaws/v1/conf/jobs/{job_id}
Submit a manual or scheduled job
POST /almaws/v1/conf/jobs/{job_id}
Retrieve Job Instances
GET /almaws/v1/conf/jobs/{job_id}/instances
Retrieve Job Instance Details
GET /almaws/v1/conf/jobs/{job_id}/instances/{instance_id}

Sets

APIPath
Retrieve a list of Sets
GET /almaws/v1/conf/sets
Create a Set
POST /almaws/v1/conf/sets
Delete a Set
DELETE /almaws/v1/conf/sets/{set_id}
Retrieve a Set
GET /almaws/v1/conf/sets/{set_id}
Manage Members
POST /almaws/v1/conf/sets/{set_id}
Retrieve Set Members
GET /almaws/v1/conf/sets/{set_id}/members

Deposit Profiles

APIPath
Retrieve Deposit Profiles
GET /almaws/v1/conf/deposit-profiles
Retrieve Deposit Profile
GET /almaws/v1/conf/deposit-profiles/{deposit_profile_id}

Import Profiles

APIPath
Retrieve Import Profiles
GET /almaws/v1/conf/md-import-profiles
Retrieve Import Profile
GET /almaws/v1/conf/md-import-profiles/{profile_id}
MD Import op - Deprecated
POST /almaws/v1/conf/md-import-profiles/{profile_id}

Integration Profiles

APIPath
Retrieve a list of Integration Profiles
GET /almaws/v1/conf/integration-profiles
Retrieve an Integration Profile
GET /almaws/v1/conf/integration-profiles/{id}

Utilities

APIPath
Retrieve Fine Fee Report
GET /almaws/v1/conf/utilities/fee-transactions

Reminders

APIPath
Retrieve a list of Reminders
GET /almaws/v1/conf/reminders
Create a Reminder
POST /almaws/v1/conf/reminders
Delete a Reminder
DELETE /almaws/v1/conf/reminders/{reminder_id}
Retrieve a Reminder
GET /almaws/v1/conf/reminders/{reminder_id}
Update a Reminder
PUT /almaws/v1/conf/reminders/{reminder_id}

Test

APIPath
GET Conf Test API
GET /almaws/v1/conf/test
POST Conf Test API
POST /almaws/v1/conf/test

OpenAPI Specification

For information about the OpenAPI standard, see the OpenAPI Initiative. You can also read about OpenAPI support in Ex Libris APIs.

OpenAPI Specification

Download the OpenAPI specification for these APIs in JSON or YAML format:

Swagger Codegen

Download an SDK powered by the Swagger Code Generator:

Download SDK
Swagger Editor

The Swagger Editor provides a side-by-side view of the specification and the Swagger UI console. It's an easy way to explore the standard and learn by playing.

View this API specification in the Swagger Editor

 

ConfigurationDepartmentsLibrariesCode tablesOpen HoursJobsSetsLocationsJob instances