Enrichment datasets

Enrichment datasets add additional detail to provisions of a work.

The provisions (chapters, sections, paragraphs, etc.) of a work can be enriched with additional information. This information is stored separately to the content of the provision.

Explore the tutorial for working with enrichment datasets.

Module 2: Enrichments and interactivity

These enrichments are grouped into enrichment datasets. An enrichment dataset contains multiple enrichments for multiple works.

An enrichment dataset has a root taxonomy topic. This is the root of the taxonomy tree that the enrichment dataset uses. Provisions enriched by the dataset can be tagged with a taxonomy topic that is part of the enrichment dataset's taxonomy tree.

An enrichment is made up of:

• the work being enriched

• the eId of the provision being enriched

• the enrichment data:

  • a topic in the taxonomy topic tree associated with the enrichment dataset

An enrichment applies to a provision across all expressions of a work.

List enrichment datasets

API for fetching details of enrichment datasets that contain provision-level enrichments for works.

GET/v3/enrichment-datasets

Authorization

cookieAuthtokenAuth

Query parameters

Response

200

Body

application/json

countinteger

nextnullable string

previousnullable string

resultsarray of EnrichmentDatasetSummary (object)

Request

JavaScriptCurl

const response = await fetch('/v3/enrichment-datasets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 123,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "name": "text",
      "description": "text",
      "url": "https://example.com",
      "created_at": "2024-05-02T19:22:05.470Z",
      "updated_at": "2024-05-02T19:22:05.470Z"
    }
  ]
}

Get details of an enrichment dataset

API for fetching details of enrichment datasets that contain provision-level enrichments for works.

GET/v3/enrichment-datasets/{id}

Authorization

cookieAuthtokenAuth

Path parameters

id*integer

A unique integer value identifying this enrichment dataset.

Response

200

Body

application/json

id*integer

name*string

Name of this dataset

description*string

Description of this dataset

url*string (uri)

URL for the dataset's content

created_at*string (date-time)

Date and time of creation

updated_at*string (date-time)

Date and time of last update

enrichments*array of EnrichmentDatasetProvision (object)

Enriched provisions that make up this dataset.

taxonomy*all of

Taxonomy topic that forms the root of the enrichment taxonomy for this dataset.

Request

JavaScriptCurl

const response = await fetch('/v3/enrichment-datasets/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "url": "https://example.com",
  "created_at": "2024-05-02T19:22:05.470Z",
  "updated_at": "2024-05-02T19:22:05.470Z",
  "enrichments": [
    {
      "provision_id": "text",
      "taxonomy_topic": "text",
      "work": "text"
    }
  ],
  "taxonomy": {
    "name": "text",
    "slug": "text",
    "children": []
  }
}