{ "openapi": "3.0.2", "info": { "title": "OpenAtlas API", "description": "An API that allows user to access data from an OpenAtlas instance.", "version": "0.4.7e", "contact": { "name": "OpenAtlas", "url": "https://openatlas.eu", "email": "bernhard.koschicek-krombholz@oeaw.ac.at" }, "license": { "name": "GPL-2.0", "url": "https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html" } }, "servers": [ { "url": "https://demo.openatlas.eu/api/{basePath}", "description": "Demo Server", "variables": { "basePath": { "default": "0.4", "enum": [ "0.4" ] } } }, { "url": "https://demo-dev.openatlas.eu/api/{basePath}", "description": "Demo Dev Server", "variables": { "basePath": { "default": "0.4", "enum": [ "0.4" ] } } } ], "externalDocs": { "description": "OpenAtlas API Manual", "url": "https://manual.openatlas.eu/technical/api.html" }, "tags": [ { "name": "Entity Endpoint", "description": "Information about a single entity. The requested information is provided in Linked Places format (LPF). Alternatively, Linked Open Art (LOUD), GeoJSON or RDFs, derived from the LOUD format, can be accessed." }, { "name": "Entity Query Endpoint", "description": "Combines several endpoints in one query." }, { "name": "Entities Endpoint", "description": "Information about multiple entities. The requested information is provided in Linked Places format (LPF). Alternatively, Linked Open Art (LOUD), GeoJSON or RDFs, derived from the LOUD format, can be accessed." }, { "name": "Type Endpoints", "description": "Information about types. The requested information is provided in a custom JSON format." }, { "name": "Administrative Endpoints", "description": "Additional information for presentation sites." }, { "name": "Special Endpoints", "description": "Customized endpoints" }, { "name": "Image Endpoints", "description": "Provides image files" }, { "name": "Proposal", "description": "Endpoint in development state" } ], "paths": { "/entity/{entityId}": { "get": { "tags": [ "Entity Endpoint" ], "description": "Retrieves information about a single entity.", "operationId": "GetEntity", "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/LinkedPlacesModel" }, { "$ref": "#/components/schemas/GeoJSONModel" } ] } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/entity_presentation_view/{entityId}": { "get": { "tags": [ "Proposal" ], "description": "Retrieves an Entity with its linked data for presentation sites", "parameters": [ { "$ref": "#/components/parameters/entityId" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresentationViewModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/query/": { "get": { "tags": [ "Entities Endpoint", "Entity Query Endpoint" ], "description": "Retrieves a list with entity ID, CIDOC CRM code, system class, or view class. You can combine these endpoints in a single query.", "operationId": "GetQuery", "parameters": [ { "$ref": "#/components/parameters/entities" }, { "$ref": "#/components/parameters/view_classes" }, { "$ref": "#/components/parameters/system_classes" }, { "$ref": "#/components/parameters/cidoc_classes" }, { "$ref": "#/components/parameters/linked_entities" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/centroid" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/system_class/{system_class}": { "get": { "tags": [ "Entities Endpoint" ], "description": "Retrieves entities based on their OpenAtlas class name.", "operationId": "GetBySystemClass", "parameters": [ { "$ref": "#/components/parameters/system_class" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/view_class/{view_class}": { "get": { "tags": [ "Entities Endpoint" ], "description": "Retrieves entities based on their OpenAtlas view class.", "operationId": "GetByViewClass", "parameters": [ { "$ref": "#/components/parameters/view_class" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/cidoc_class/{cidoc_class}": { "get": { "tags": [ "Entities Endpoint" ], "description": "Retrieves entities based on their CIDOC CRM class code.", "operationId": "GetByCidocClass", "parameters": [ { "$ref": "#/components/parameters/cidoc_class" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/latest/{limit}": { "get": { "tags": [ "Entities Endpoint" ], "description": "Retrieves the last entered entities. `{limit}` represents the amount of entities (between 1 and 100). The pagination information is always null.", "operationId": "GetLatest", "parameters": [ { "in": "path", "name": "limit", "required": true, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/type_entities/{entityId}": { "get": { "tags": [ "Entities Endpoint" ], "description": "Retrieves entities using provided `{entityId}` as their type. To get available types, Types Endpoints can be used.", "operationId": "GetTypeEntities", "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/type_entities_all/{entityId}": { "get": { "tags": [ "Entities Endpoint" ], "description": "Retrieves entities based on their OpenAtlas type ID including all connected subtypes. To get available types see Types Endpoints.", "operationId": "GetTypeEntitiesAll", "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/entities_linked_to_entity/{entityId}": { "get": { "tags": [ "Entities Endpoint" ], "description": "Retrieves entities linked to the entity with the provided `{entityId}`.", "operationId": "GetEntitiesLinkedToEntity", "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/linked_entities_by_properties_recursive/{entityId}": { "get": { "tags": [ "Proposal" ], "description": "Retrieves all entities linked with the provided property to the entity with the provided `{entityId}` in a recursive manner.", "operationId": "GetLinkedEntitiesByPropertyRecursive", "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/properties" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/show" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/export" }, { "$ref": "#/components/parameters/column" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/search" }, { "$ref": "#/components/parameters/first" }, { "$ref": "#/components/parameters/last" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/type_id" }, { "$ref": "#/components/parameters/relation_type" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/centroid" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EntitiesOutputModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/type_overview/": { "get": { "tags": [ "Type Endpoints" ], "description": "Retrieves all OpenAtlas types sorted by custom, places, standard, system and value types.", "operationId": "GetTypeOverview", "parameters": [ { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOverviewModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/type_tree/": { "get": { "tags": [ "Type Endpoints" ], "description": "Retrieves a flat list of all types.", "operationId": "GetTypeTree", "parameters": [ { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeTreeModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/type_by_view_class/": { "get": { "tags": [ "Type Endpoints" ], "description": "Retrieves standard types in a hierarchical order.", "operationId": "GetTypeByViewClass", "parameters": [ { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypesByViewClassModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/classes/": { "get": { "tags": [ "Administrative Endpoints" ], "description": "Retrieves all OpenAtlas classes with their English label, CIDOC CRM mapping, view, icon and standard type ID.", "operationId": "Classes", "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassesModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/openapi_schema/": { "get": { "tags": [ "Administrative Endpoints" ], "description": "Retrieves OpenApi3 schema for this instance. Formats are `json` or `yaml`.", "operationId": "openapi_schema", "security": [], "parameters": [ { "name": "format", "description": "Choose the format for the results.", "in": "query", "schema": { "type": "string", "enum": [ "json", "yaml" ] }, "example": "json" } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/class_mapping/": { "get": { "tags": [ "Proposal" ], "description": "Retrieves all OpenAtlas classes with their label, CIDOC CRM mapping, view, icon and standard type ID. Label language is English by default but can be changed by `locale` parameter", "operationId": "ClassMapping", "parameters": [ { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassMappingModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/properties/": { "get": { "tags": [ "Proposal" ], "description": "Retrieves all OpenAtlas CIDOC properties with their label, name, name inverse, code and translations.", "operationId": "GetProperties", "parameters": [ { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertiesModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/network_visualisation/": { "get": { "tags": [ "Proposal" ], "description": "Retrieves a list of object with id, system_class, label and related ids", "operationId": "GetNetworkVisualisation", "parameters": [ { "$ref": "#/components/parameters/exclude_system_classes" }, { "$ref": "#/components/parameters/linked_to_ids" }, { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkVisualisationModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/backend_details/": { "get": { "tags": [ "Administrative Endpoints" ], "description": "Retrieves a list of backend configuration settings.", "operationId": "GetBackendDetails", "parameters": [ { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackendDetailsModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/system_class_count/": { "get": { "tags": [ "Administrative Endpoints" ], "description": "Retrieves system classes with a count of their instances.", "operationId": "SystemClassCount", "parameters": [ { "$ref": "#/components/parameters/type_id" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemClassCountModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/subunits/{entityId}": { "get": { "tags": [ "Special Endpoints" ], "description": "Retrieves all subunits of a place in a special format, used by e.g. ARIADNEplus and THANADOS.", "operationId": "GetSubunits", "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/download" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubunitsModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/chained_events/{entityId}": { "get": { "tags": [ "Proposal" ], "description": "Get the chain of successive events also with forks but no super or sub events if they are not in the chain.", "operationId": "GetChainedEvents", "parameters": [ { "$ref": "#/components/parameters/entityId" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChainEventModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/geometric_entities/": { "get": { "tags": [ "Special Endpoints" ], "description": "Retrieves a detailed GeoJSON of all chosen geometries, e.g. used for Leaflet maps.", "operationId": "GetGeometricEntities", "parameters": [ { "$ref": "#/components/parameters/geometry" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/count" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeometricEntitiesModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/export_database/{format}": { "get": { "tags": [ "Special Endpoints" ], "description": "Downloads all information as CSV, XML, or JSON.", "operationId": "ExportDatabase", "parameters": [ { "in": "path", "name": "format", "required": true, "schema": { "type": "string", "enum": [ "json", "csv", "xml" ] }, "example": "json" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/display/{fileId}": { "get": { "tags": [ "Image Endpoints" ], "description": "Retrieves the image connected to the requested ID or entityID, if it has a licence.", "operationId": "DisplayImage", "parameters": [ { "$ref": "#/components/parameters/fileId" }, { "in": "query", "name": "image_size", "required": false, "schema": { "type": "string", "enum": [ "thumbnail", "table" ] } } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/iiif_manifest/{version}/{fileId}": { "get": { "tags": [ "Image Endpoints" ], "description": "Retrieves the manifest of the IIIF image.", "operationId": "IIIFManifest", "parameters": [ { "in": "path", "name": "version", "required": true, "schema": { "enum": [ 2 ] } }, { "$ref": "#/components/parameters/fileId" }, { "$ref": "#/components/parameters/url" } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } }, "/licensed_file_overview/": { "get": { "tags": [ "Administrative Endpoints" ], "description": "Retrieves all existing files with a licence and their display URL, thumbnail URL, extension and license. With the parameter `{file_id}` specific files can be retrieved.", "operationId": "LicensedFileOverview", "parameters": [ { "in": "query", "name": "file_id", "required": false, "schema": { "type": "integer" } } ], "security": [ { "bearerHttpAuthentication": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicensedFileOverviewModel" } } } }, "404": { "description": "Something went wrong. Please consult the error message." } } } } }, "components": { "securitySchemes": { "bearerHttpAuthentication": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "parameters": { "entityId": { "name": "entityId", "in": "path", "description": "Specific entity ID", "required": true, "schema": { "type": "integer" }, "example": 40 }, "fileId": { "name": "fileId", "in": "path", "description": "Specific ID of a file entity.", "required": true, "schema": { "type": "integer" }, "example": 40 }, "cidoc_class": { "name": "cidoc_class", "description": "CIDOC class to be requested", "required": true, "in": "path", "schema": { "enum": [ "all", "E5", "E7", "E8", "E9", "E12", "E18", "E20", "E21", "E22", "E31", "E32", "E33", "E41", "E53", "E54", "E55", "E65", "E74" ] }, "example": "E18" }, "view_class": { "name": "view_class", "description": "View class to be requested", "required": true, "in": "path", "schema": { "enum": [ "all", "actor", "artifact", "event", "file", "place", "reference", "reference_system", "source", "source_translation", "type" ] }, "example": "actor" }, "system_class": { "name": "system_class", "description": "System class to be requested", "required": true, "in": "path", "schema": { "enum": [ "all", "acquisition", "activity", "administrative_unit", "appellation", "artifact", "bibliography", "creation", "edition", "event", "external_reference", "feature", "file", "group", "human_remains", "modification", "move", "person", "place", "production", "reference_system", "source", "source_translation", "stratigraphic_unit", "type", "type_tools" ] }, "example": "acquisition" }, "download": { "name": "download", "description": "Download results", "in": "query", "schema": { "type": "boolean" } }, "count": { "name": "count", "description": "Show integer count of how many entities would the result give back", "in": "query", "schema": { "type": "boolean" } }, "centroid": { "name": "centroid", "description": "Will calculate the centerpoint for all polygons and linestrings and *add* them to geometries", "in": "query", "schema": { "type": "boolean" } }, "locale": { "name": "locale", "description": "Choose language for system inherent labels", "in": "query", "schema": { "type": "string", "enum": [ "ca", "de", "en", "es", "fr" ], "default": "en", "example": "de" } }, "show": { "name": "show", "description": "Select which keys should not be displayed. This can improve performance", "in": "query", "explode": true, "schema": { "type": "array", "items": { "enum": [ "when", "types", "relations", "names", "links", "geometry", "depictions", "geonames", "description", "none" ] } } }, "sort": { "name": "sort", "description": "Sorting result ascending or descending of the given column. Default value is asc.", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "example": "asc" }, "column": { "name": "column", "description": "Choose one column to sort the results by. Default value is name.", "in": "query", "schema": { "type": "string", "enum": [ "id", "name", "cidoc_class", "system_class", "begin_from", "begin_to", "end_from", "end_to" ] }, "example": "name" }, "search": { "name": "search", "description": "Search query for specific results.\n\n **Filterable categories**\n\n entityName, entityDescription, entityAliases, entityCidocClass, entitySystemClass, entityID, typeID, valueTypeID, typeIDWithSubs, typeName, beginFrom, beginTo, endFrom, endTo, relationToID\n\n **Values** \n\n Values has to be a list of items. The items can be either a string, an integer or a tuple (see Notes). Strings need to be marked with \u201c\u201d or \u2018\u2019, while integers does not allow this. \n \n *Notes*: \n The category valueTypeID can search for values of a type ID. But it takes one or more two valued Tuple as list entry: (x,y). x is the type id and y is the searched value. This can be an int or a float, e.g: `{\"operator\":\"lesserThan\",\"values\":[(3142,543.3)],\"logicalOperator\":\"and\"}`\n The date categories (beginFrom, beginTo, endFrom, endTo) only allow *one* value in the **values** field and it has to be formated the following way: YYYY-MM-DD. Month and day values need to filled up with 0, e.g. 800-01-01 \n\n **Compare operators** \n\n equal, notEqual, like (1), greaterThan (2), greaterThanEqual (2), lesserThan (2)\n\nThe compare operators work like the mathematical operators. equal x=y, notEqual x!=y, greaterThan x>y , greaterThanEqual x>=y, lesserThan x