Europeana Knowledge Base

https://europeana.atlassian.net/wiki/spaces/EF/pages
Admin
Europeana Knowledge Base provides comprehensive documentation and guidelines for data providers on...
Tokens:221,484
Snippets:3,214
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Retrieve Entity Call Example

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2324561923/Entity%2BAPI%2BDocumentation

Example of a GET request and the corresponding JSON-LD response for an entity.

```http
GET https://api.europeana.eu/entity/agent/base/147466
```

```json
{ "@context": "http://www.europeana.eu/schemas/context/entity.jsonld", "id": "http://data.europeana.eu/agent/147466", "type": "Agent", "isShownBy": {  "id": "http://atena.beic.it/webclient/DeliveryManager?pid=8366128&custom_att_2=deeplink",  "type": "WebResource",  "source": "http://data.europeana.eu/item/9200369/webclient_DeliveryManager_pid_8365778_custom_att_2_simple_viewer",  "thumbnail": "https://api.europeana.eu/api/v2/thumbnail-by-url.json?uri=http%3A%2F%2Fatena.beic.it%2Fwebclient%2FDeliveryManager%3Fpid%3D8366399%26custom_att_2%3Ddeeplink&type=SOUND" }, "prefLabel": {  "de": "Arturo Toscanini",  "fi": "Arturo Toscanini",  "ru": "Артуро Тосканини",  "sv": "Arturo Toscanini",  "pt": "Arturo Toscanini",  "bg": "Артуро Тосканини",  "el": "Αρτούρο Τοσκανίνι",  "en": "Arturo Toscanini",  "hr": "Arturo Toscanini",  "it": "Arturo Toscanini",  "fr": "Arturo Toscanini",  "hu": "Arturo Toscanini",  "eu": "Arturo Toscanini",  "sk": "Arturo Toscanini",  "sl": "Arturo Toscanini",  "ga": "Arturo Toscanini",  "pl": "Arturo Toscanini",  "ro": "Arturo Toscanini",  "ca": "Arturo Toscanini",  "nl": "Arturo Toscanini" }, "altLabel": {  "ru": [  "Тосканини, Артуро"  ] }, "dateOfBirth": "1867-03-25", "dateOfDeath": "1957-01-16", "placeOfBirth": "http://data.europeana.eu/place/148579",  "note": {  "de": [  "Italienischer Dirigent"  ],  "ru": [  "Итальянский дирижёр"  ],  "fi": [  "Italialainen kapellimestari"  ],  "sv": [  "Italiensk dirigent"  ],  "bg": [  "Италиански диригент"  ],  "el": [  "Ιταλός διευθυντής ορχήστρας"  ],  "en": [  "Italian conductor (1867-1957)"  ],  "it": [  "Direttore d'orchestra italiano (1867-1957)"  ],  "fr": [  "Chef d'orchestre italien"  ],  "pl": [  "Dyrygent włoski"  ],  "hu": [  "Olasz karmester"  ],  "nl": [  "Italiaans dirigent"  ]  }, "hasMet": [  "http://data.europeana.eu/concept/235" ], "sameAs": [  "http://www.wikidata.org/entity/Q13003",  "http://viaf.org/viaf/19867298",  "https://d-nb.info/gnd/118623443",  "http://id.loc.gov/authorities/names/n50014549",  "http://data.bnf.fr/ark:/12148/cb139005146",  "http://www.idref.fr/027369293/id",  "http://id.ndl.go.jp/auth/ndlna/00621569",  "https://www.freebase.com/m/0140v2",  "https://g.co/kg/m/0140v2",  "http://openlibrary.org/works/OL5191079A",  "http://libris.kb.se/resource/auth/313235",  "http://datos.bne.es/resource/XX1282069",  "http://data.bibliotheken.nl/id/thes/p072682442",  "https://livedata.bibsys.no/authority/90606822",  "http://id.worldcat.org/fast/4524",  "http://data.cervantesvirtual.com/person/54819",  "http://data.carnegiehall.org/names/10549",  "https://libris.kb.se/mkz26r652wmwhm9",  "http://dbpedia.org/resource/Arturo_Toscanini" ], "isAggregatedBy": {  "id": "http://data.europeana.eu/agent/147466#aggregation",  "type": "Aggregation",  "created": "2023-01-20T14:56:39Z",  "modified": "2023-01-20T14:56:39Z",  "pageRank": 36,  "recordCount": 0,  "score": 658,  "aggregates": [  "http://data.europeana.eu/agent/147466#aggr_europeana",  "http://data.europeana.eu/agent/147466#aggr_source_1" ] } }
```

--------------------------------

### Make IIIF Installation Script Executable

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2355396609/IIIF%2BImage%2BConversion%2BCompact%2BVersion

Sets the execution permissions for the installation script before running it.

```bash
sudo chmod +x iiif-install.sh
```

--------------------------------

### Execute IIIF Installation Script

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2355396609/IIIF%2BImage%2BConversion%2BCompact%2BVersion

Runs the installation script with administrator privileges to set up the web and image servers.

```bash
sudo ./iiif-install.sh
```

--------------------------------

### Install libvips-tools on Ubuntu

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2343010305/IIIF%2BImage%2BConversion%2BGuide

Use the apt-get package manager to install the necessary VIPS image processing tools.

```bash
sudo apt-get install libvips-tools
```

--------------------------------

### Install Apache2 and fcgid module

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2343010305/IIIF%2BImage%2BConversion%2BGuide

Installs the Apache web server and the FastCGI module required for IIPImage server communication.

```bash
sudo apt-get install apache2 libapache2-mod-fcgid
```

--------------------------------

### Annotation Search Request Examples

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2385870851

Various query string examples for searching, filtering, and sorting annotations.

```text
/search?wskey=xxxxx &profile=minimal&query=*:*&qf=motivation:tagging&sort=created&sortOrder=desc
```

```text
/search?wskey=xxxxx &profile=minimal&query=target_id:"/92028/532E53363138382D2F290A40B3CA26B3889A6907"
```

```text
/search?wskey=xxxxx &profile=minimal&query=*:*&qf=moderation_score:[-1 TO *]
```

--------------------------------

### Complete JSON-LD Annotation Example

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

A full example of a tagging annotation including provenance and metadata fields.

```json
{   "@context": "http://www.w3.org/ns/anno.jsonld",   "id": "http://data.europeana.eu/annotations/1",   "type": "Annotation",   "created": "2015-03-10T14:08:07Z",   "creator": {     "type": "Person",     "name": "John Smith"   },   "generated": "2015-04-01T09:00:00Z",   "generator": {     "type": "Software",     "name": "HistoryPin",     "homepage": "https://www.historypin.org/"   },   "motivation": "tagging",   "bodyValue": "MyTag",   "target": "http://data.europeana.eu/item/09102/_UEDIN_214" }
```

--------------------------------

### Aggregation metadata example

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2346614785/Europeana%2Bautomatic%2Benrichment%2Bwith%2Borganisations

Example of how data partners include organisation information within the aggregation chain.

```xml
<ore:Aggregation rdf:about="#Example_01Aggregation">         <edm:aggregatedCHO rdf:resource="#Example_01"/>         <edm:dataProvider>Bibliothèque nationale de France</edm:dataProvider>         <edm:intermediateProvider>The European Library</edm:intermediateProvider>         <edm:provider>Gallica</edm:provider>         [ other Aggregation data ] </ore:Aggregation>
```

--------------------------------

### Record API Request Example

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2385674279/Record%2BAPI%2BDocumentation

Example of a standard HTTPS request to retrieve record data in JSON format.

```text
https://api.europeana.eu/record/v2/90402/RP_P_1984_87.json?wskey=YOURAPIKEY
```

--------------------------------

### Create Annotation Response

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2385870851/Annotation%2BAPI%2BDocumentation

Example response received after a successful annotation creation.

```HTTP
 Content-Type: application/ld+json ETag: "_87e52ce126126" Link: <http://www.w3.org/ns/ldp#Resource>l; rel="type" Allow: POST,GET,OPTIONS,HEAD Vary: Accept Content-Length: 999 {   "@context": "http://www.w3.org/ns/anno.jsonld",   "id": "http://data.europeana.eu/annotation/base/1",   "type": "Annotation",   "created": "2016-01-31T12:03:45Z",   "creator": "http://data.europeana.eu/user/55376",   "generated": "2016-01-31T12:04:00Z",   "generator": "http://data.europeana.eu/provider/historypin",   "bodyValue": "Trombone",   "motivation": "tagging",   "target": "http://data.europeana.eu/item/09102/_UEDIN_214" } 
```

--------------------------------

### owl:sameAs XML Example

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2106195985/edm%2BAgent

Links to an external URI that identifies the same Agent.

```xml
<owl:sameAs rdf:resource="http://www.identifier/sameResourceElsewhere"/>
```

--------------------------------

### Annotate a Transcription

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/null

Examples of linking images to transcriptions in various formats, including plain text, PageXML, and ALTO.

```json
{   "motivation": "transcribing",   "body": {     "type": "FullTextResource",     "language": "de",     "edmRights": "http://creativecommons.org/licenses/by-sa/1.0/",     "value": "... complete transcribed plain text ...",     "format": "text/plain"   },   "target": {     "scope": "http://data.europeana.eu/item/2020601/contributions_20841",     "source":      "http://www.europeana1914-1918.eu/attachments/2020601/20841.235882.full.jpg"   } }
```

```json
{   "motivation": "transcribing",   "body": {     "type": "FullTextResource",    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<PcGts xmlns=\"http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15 http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15/pagecontent.xsd\">\n       … \t</PcGts>",     "edmRights": "http://creativecommons.org/publicdomain/zero/1.0/",     "format": "application/vnd.prima.page+xml",     "language": "en"   },   "target": {     "scope": "http://data.europeana.eu/item/some_cho",     "source": "https://example.org/some_web_resource.jpg"   } }
```

```json
{   "motivation": "transcribing",   "body": {     "type": "FullTextResource",     "value": "<?xml version="1.0" encoding="UTF-8"?><alto><Description> <MeasurementUnit>pixel</MeasurementUnit> … </alto>",     "edmRights": "http://creativecommons.org/publicdomain/zero/1.0/",     "format": "text/xml",     "conformsTo": “http://www.loc.gov/standards/alto/ns-v4#”,     "language": "en"   },   "target": {     "scope": "http://data.europeana.eu/item/some_cho",     "source": "https://example.org/some_web_resource.jpg"   } }
```

--------------------------------

### Example of an edm:ProvidedCHO with bias terms

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

A JSON-LD representation of a ProvidedCHO containing multiple occurrences of a bias term across different fields.

```json
{   "id": "http://data.europeana.eu/item/some_cho",   "type": "ProvidedCHO",   "dc:description": [     {       "@value": "A description with a bias term. Also, the bias term appears twice.",       "@language": "en"     },     {       "@value": "This description also contains the same bias term",       "@language": "en"     }   },   "dc:title": {      "@value": "The title contains the same bias term",      "@language": "en"   },   … }
```

--------------------------------

### Annotating an image with an ALTO transcription

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

Example of an annotation linking an image to an English transcription provided in ALTO format.

```json
{   "motivation": "transcribing",   "body": {     "type": "FullTextResource",     "value": "<?xml version="1.0" encoding="UTF-8"?><alto><Description> <MeasurementUnit>pixel</MeasurementUnit> … </alto>",     "edmRights": "http://creativecommons.org/publicdomain/zero/1.0/",     "format": "text/xml",     "conformsTo": “http://www.loc.gov/standards/alto/ns-v4#”,     "language": "en"   },   "target": {     "scope": "http://data.europeana.eu/item/some_cho",     "source": "https://example.org/some_web_resource.jpg"   } }
```

--------------------------------

### Annotating an image with a PageXML transcription

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

Example of an annotation linking an image to an English transcription provided in PageXML format.

```json
{   "motivation": "transcribing",   "body": {     "type": "FullTextResource",    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<PcGts xmlns=\"http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15 http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15/pagecontent.xsd\">\n       … \t</PcGts>",     "edmRights": "http://creativecommons.org/publicdomain/zero/1.0/",     "format": "application/vnd.prima.page+xml",     "language": "en"   },   "target": {     "scope": "http://data.europeana.eu/item/some_cho",     "source": "https://example.org/some_web_resource.jpg"   } }
```

--------------------------------

### Tagging a web resource associated with a CHO

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

Example of an annotation targeting a specific web resource associated with a Cultural Heritage Object (CHO).

```json
{   "motivation": "tagging",   "bodyValue": "Animals",   "target": {     "type": "SpecificResource",     "scope": "http://data.europeana.eu/item/5510/_MVoNr_5_987",     "source": "https://www.volkskundemuseum.at/jart/prj3/volkskundemuseum/data/collection-exports/hafnergeschirr/hafnergeschirr_0_000_000_022.jpg"   } }
```

--------------------------------

### Define an edm:RDFStatementSelector for a dc:description statement

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

Example of a JSON-LD target structure using an edm:RDFStatementSelector to isolate a specific dc:description statement within a CHO.

```json
{   …   "target": {     "source" : "http://example.org/some_cho",     "selector" : {       "type" : "RDFStatementSelector",       "hasSubject" : "http://example.org/some_cho",       "hasPredicate": "dc:description",       "hasObject" : "Stalenboek met hoofdzakelijk stalen in beschilderd papier; ingebonden in bruin leder"     }   }   … }
```

--------------------------------

### Annotation highlighting bias terms in CHO metadata

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

An example of a Web Annotation targeting specific occurrences of a bias term in the title and description fields of a CHO.

```json
{   "@context": [     "http://www.w3.org/ns/anno.jsonld",     "https://api.europeana.eu/schema/context/edm.jsonld"   },   "id": "http://example.org/anno29",   "type": "Annotation",   "motivation": "highlighting",   "body": "http://debias.example.org/term/xpto",   "target": [     {       "source": "http://data.europeana.eu/item/some_cho",       "selector": {         "type" : "RDFStatementSelector",         "hasPredicate": "dc:title",         "refinedBy" : {           "type" : "TextQuoteSelector",           "exact": {             "@value": "bias term",             "@language": "en"           },           "prefix": "same "         }       }     },     {       "source": "http://data.europeana.eu/item/some_cho",       "selector": {         "type" : "RDFStatementSelector",         "hasPredicate": "dc:description",         "refinedBy" : {           "type" : "TextQuoteSelector",           "exact": {             "@value": "bias term",             "@language": "en"           },           "prefix": "with a ",           "suffix": ". Also"         }       },       ...    ]   ... }
```

--------------------------------

### Unqualified CHO Link Annotation

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

An annotation example for a non-directed link between two CHOs, requiring an oa:motivation of 'linking' and at least two oa:target properties.

```json
{   "motivation": "linking",   "target": [     "http://data.europeana.eu/item/09102/_UEDIN_214",     "http://data.europeana.eu/item/09102/_RMAH_119385_NL"   ] }
```

--------------------------------

### Qualified CHO Link Annotation

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/4465491973/Annotations%2Bprofile

An annotation example for a directed link between two CHOs, using an oa:body with a @graph construct to define the specific relationship.

```json
{   "motivation": "linking",   "body": {     "@graph": {       "@context": "https://api.europeana.eu/schema/context/edm.jsonld",       "id": "http://data.europeana.eu/item/09102/_UEDIN_214",       "isNextInSequence": "http://data.europeana.eu/item/09102/_RMAH_119385_NL"     }   },   "target": [     "http://data.europeana.eu/item/09102/_UEDIN_214",     "http://data.europeana.eu/item/09102/_RMAH_119385_NL"   ] }
```

--------------------------------

### Start the Apache web server

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2343010305/IIIF%2BImage%2BConversion%2BGuide

Initiates the Apache2 service using systemctl.

```bash
sudo systemctl start apache2
```

--------------------------------

### Resolve entity request and response

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2324561923

Example of a GET request to resolve a DBpedia URI and the resulting HTTP 301 redirect.

```http
GET https://api.europeana.eu/entity/resolve?wskey=apidemo&uri=http://dbpedia.org/resource/Leonardo_da_Vinci
```

```http
HTTP 301 data.europeana.eu/agent/146741
```

--------------------------------

### oEmbed Request and Response

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2820177937/Embeddable%2Bresources%2Bin%2BEDM%2Bguidelines

Example of a GET request to a Flickr oEmbed endpoint and the resulting JSON response containing metadata and embed HTML.

```http
GET https://www.flickr.com/services/oembed/?url=http%3A%2F%2Fwww.flickr.com%2Fphotos%2Fbritishlibrary%2F11197949844%2F&format=json
```

```json
{ type: "photo", flickr_type: "photo", title: "British Library digitised image from page 96 of "A Historical Geography of the British Colonies (of the British Empire)"", author_name: "The British Library", author_url: "https://www.flickr.com/photos/britishlibrary/", width: 1024, height: 671, url: "https://live.staticflickr.com/3689/11197949844_a597c92047_b.jpg", web_page: "https://www.flickr.com/photos/britishlibrary/11197949844/", thumbnail_url: "https://live.staticflickr.com/3689/11197949844_a597c92047_q.jpg", thumbnail_width: 150, thumbnail_height: 150, web_page_short_url: "https://flic.kr/p/i4wqmL", license: "No known copyright restrictions", license_url: "https://www.flickr.com/commons/usage/", license_id: "7", html: "<a data-flickr-embed=\"true\" href=\"https://www.flickr.com/photos/britishlibrary/11197949844/\" title=\"British Library digitised image from page 96 of &quot;A Historical Geography of the British Colonies (of the British Empire)&quot; by The British Library, on Flickr\"><img src=\"https://live.staticflickr.com/3689/11197949844_a597c92047_b.jpg\" width=\"1024\" height=\"671\" alt=\"British Library digitised image from page 96 of &quot;A Historical Geography of the British Colonies (of the British Empire)&quot;\"></a><script async src=\"https://embedr.flickr.com/assets/client-code.js\" charset=\"utf-8\"></script>", version: "1.0", cache_age: 3600, provider_name: "Flickr", provider_url: "https://www.flickr.com/" }
```

--------------------------------

### Facet Response Example

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2385739812/Search%2BAPI%2BDocumentation

Example JSON response containing facet data.

```json
{   "apikey": "YOURAPIKEY",   "success": true,   "requestNumber": 999,   "totalResults": 62029238,   "items": [],   "facets": [     {       "name": "RIGHTS",       "fields": [         {           "label": "http://rightsstatements.org/vocab/InC/1.0/",           "count": 21135772         },         ...         {           "label": "http://creativecommons.org/licenses/by-nc-nd/3.0/de/",           "count": 2732         }       ]     }     ...   ] }
```

--------------------------------

### Language Map Example

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2385739812/Search%2BAPI%2BDocumentation

Example of a LangMap datatype representing a title in Portuguese.

```json
"dcTitle": {"por": ["Paris"]}
```

--------------------------------

### Example Europeana organisation URL

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2617442393

An example of a URL for an organisation entity on the Europeana website.

```text
https://www.europeana.eu/en/collections/organisation/4513-naturalis-biodiversity-center
```

--------------------------------

### Flagging a WebResource for oEmbed compliance in RDF/XML

Source: https://europeana.atlassian.net/wiki/spaces/EF/pages/2820177937/Embeddable%2Bresources%2Bin%2BEDM%2Bguidelines

Example showing the linkage between an aggregation, a web resource, and an oEmbed service endpoint.

```xml
<ore:Aggregation rdf:about="[ … ]"> […]     <edm:isShownBy rdf:resource="https://www.flickr.com/services/oembed/?url=http%3A%2F%2Fwww.flickr.com%2Fphotos%2Fbritishlibrary%2F11197949844%2F&format=json"/> […] </ore:Aggregation> […]  <edm:WebResource rdf:about="https://www.flickr.com/services/oembed/?url=http%3A%2F%2Fwww.flickr.com%2Fphotos%2Fbritishlibrary%2F11197949844%2F&format=json">     <svcs:has_service rdf:resource="http://www.flickr.com/services/oembed/"/> […] </edm:WebResource>  <svcs:Service rdf:about="http://www.flickr.com/services/oembed/">     <dcterms:conformsTo rdf:resource="https://oembed.com/"/>     <rdfs:label>Flickr</rdfs:label> </svcs:Service>
```
Tokens:
Raw