Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Create and Assign a License


The License Management Resources consist of six endpoints that allow you to create, retrieve, update and delete licenses. A license is defined by a license object. A license object is a set of data elements that are described by a JSON schema. The license object details include items such as intellectual property rights, license type, reviewer, license duration and license end date. The License Management Resources allow you to capture license details, terms and conditions for your resources so that library staff can quickly answer questions related to the user of the content and help with configuration and renewal decisions.

A system entity is an EBSCO-KB or external entity such as a provider, package or package-title. An assignment maps a license to a system entity. The Assignment Resources consist of five endpoints that allow you to create, retrieve, delete and update your license assignments. The process to create a license and assign it to a system entity consists of the following steps:

  1. Create the License
  2. Search for the License (optional)
  3. Update the License (optional)
  4. Assign the License
  5. Retrieve the License by URL (optional)

To access the License Management Resources and the Assignment Resources, you will need a customer ID and an API key. If you need assistance obtaining you API key, please contact EBSCO customer satisfaction.