How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

University of Helsinki Documents API

The Documents API from University of Helsinki — 7 operation(s) for documents.

University of Helsinki Documents API is one of 97 APIs that University of Helsinki publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 11 JSON Schema definitions.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and 11 JSON Schemas.

This API exposes 11 operations across 7 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://api.laji.fi.

11 operations 7 paths 24 schemas 1 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://api.helsinki.fi/portal/environments/DEFAULT
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

University of Helsinki Documents API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Access_token). An API key is passed in the header as Accept-Language (Lang). An API key is passed in the header as Person-Token (Person_token).

  • Access_token — Access token
  • Lang — Sets the 'Accept-Language' header. One of 'fi', 'sv,' 'en'. Defaults to 'en'.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 11
POST
/documents/batch
Starts a batch job that validates the documents.
DocumentsController_startBatchJob 1 param body → 200400401403404406422500
GET
/documents/batch/{jobID}
Get a batch job's status.
DocumentsController_getBatchJobStatus 2 params → 200400401403404406422500
POST
/documents/batch/{jobID}
Completes a given batch job by sending them to the store/warehouse.
DocumentsController_completeBatchJob 4 params → 200400401403404406422500
POST
/documents/validate
Validate a document
DocumentsController_validate 5 params body → 204400401403404406422500
GET
/documents/count/byYear
Get count of documents by type (currently just "byYear")
DocumentsController_getCountByYear 4 params → 200400401403404406422500
GET
/documents/stats
Get the median date of documents for a named place
DocumentsController_getStatistics 1 param → 200400401403404406422500
GET
/documents
Get a page of documents
DocumentsController_getPage 11 params → 200400401403404406422500
POST
/documents
Create a new document
DocumentsController_create 1 param body → 201400401403404406422500
GET
/documents/{id}
Get a document
DocumentsController_get 2 params → 200400401403404406422500
PUT
/documents/{id}
Update an existing document
DocumentsController_update 3 params body → 200400401403404406422500
DELETE
/documents/{id}
Delete a document
DocumentsController_delete 2 params → 200400401403404406422500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are store-unit (119 properties), store-gatheringFact (103 properties), store-gathering (98 properties), store-document (79 properties). Each schema is shown below with its type and property counts.

store-unit
object
119 properties 119 required
DocumentCountItemResponse
object
2 properties 2 required
store-gatheringFact
object
103 properties 103 required
store-gatheringEvent
object
39 properties 39 required
store-unitGathering
object
8 properties 8 required
store-contact
object
11 properties 11 required
store-measurement
object
27 properties 27 required
BatchJobValidationStatus
object
3 properties 3 required
ErrorsObj
object
store-typeSpecimen
object
17 properties 17 required
store-completeList
object
5 properties 5 required
StoreDeleteResponse
object
1 property 1 required
store-lineTransectNest
object
10 properties 10 required
store-identification
object
29 properties 29 required
store-document
object
79 properties 1 required
store-unitFact
object
47 properties 47 required
store-sample
object
33 properties 1 required
store-documentIdentification
object
5 properties 5 required
BatchJobValidationStatusResponse
object
4 properties 4 required
store-preparation
object
9 properties 9 required
store-taxonCensus
object
6 properties 1 required
store-geometry
store-gathering
object
98 properties 98 required
StatisticsResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-helsinki-documents-api-openapi.yml Raw ↑

Other APIs University of Helsinki publishes across the network.

University of Helsinki API Portal (Gravitee)
Dependency Track
Flamma Liferay Headless API
Internal Guide CMS JSON-API
Helda DSpace REST API
Helda OAI-PMH Metadata Interface
HY Data Catalogue DSpace REST API
HY Data Catalogue OAI-PMH Interface
Editori (journals.helsinki.fi) OAI-PMH Interface
HY Login Service — Shibboleth IdP + OpenID Connect
Sisu (Kori) Student Information System — University of Helsinki tenant
University of Helsinki Research Portal — Elsevier Pure tenant
Where this information came from

This is an independent, third-party profile of University of Helsinki Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.