Version 0.4¶
Entity Endpoint¶
/api/0.4/entity/{id}
Endpoint provide information about one entity in the OpenAtlas instance. The requested information is provided in Linked Places format (LPF). Alternatively, Linked Open Art (LOUD), GeoJSON or RDFs, derived from the LPF data, can be accessed.
Optional Parameters |
|||
Query¶
Endpoint provide information about one entity in the OpenAtlas instance. The requested information is provided in Linked Places format (LPF). Alternatively, Linked Open Art (LOUD), GeoJSON or RDFs, derived from the LPF data, can be accessed. Combine several or all entities endpoints in one query.
/api/0.4/query?
Combine several or all entity endpoints in one query.
Retrieves a list with entity ID, CIDOC CRM code, system class, or menu item. Combine up to four of the aforementioned endpoints in a single query; each request has to be a new parameter.
Required Parameters - At least one is required for a successful request |
|||
Optional Parameters |
|||||
Multiple Entities¶
Endpoints provide information about entities in the OpenAtlas instance. The requested information is provided in Linked Places format (LPF). Alternatively, Linked Open Art (LOUD), GeoJSON or RDFs, derived from the LPF data, can be accessed.
CIDOC Class¶
/api/0.4/cidoc_class/{cidoc_class}
Retrieves a JSON list of entities based on their CIDOC CRM class 1 2
Optional Parameters |
|||||
Entities Linked to Entity¶
/api/0.4/entities_linked_to_entity/{id}
Used to retrieve a JSON list of entities linked to the entity with the stated ID 2
Optional Parameters |
|||||
Latest¶
/api/0.4/latest/{n}
Used to retrieve the last entry/entries made. The number {n} represents the amount of entities retrieved. {n} can be between 1 and 100. The pagination information is always null
Optional Parameters |
||||
System Class¶
/api/0.4/system_class/{system_class}
Retrieves a list of entities, based on their OpenAtlas system class name as JSON 1 2
Optional Parameters |
|||||
Type Entities¶
/api/0.4/type_entities/{id}
Used to retrieve a JSON list of entities, based on their OpenAtlas type 2 3
Optional Parameters |
|||||
Type Entities All¶
/api/0.4/type_entities_all/{id}
Used to retrieve a JSON list of entities, based on their OpenAtlas type and includes all connected entities 2 3
Optional Parameters |
|||||
View Class¶
/api/0.4/view_class/{view_class}
Used to retrieve a JSON list of entities based on their OpenAtlas class view
Optional Parameters |
|||||
- 1(1,2)
All codes available in OpenAtlas can be found under OpenAtlas and CIDOC CRM class mapping
- 2(1,2,3,4,5)
The result can be filtered, sorted, and manipulated through different parameters. By default 20 entities in alphabetical order are shown.
- 3(1,2)
Available IDs can be obtained by using the type-tree or node-overview endpoint.
Type Endpoints¶
Provide information about Types of an OpenAtlas instance. The results are in JSON and in a custom format.
Type by View Class¶
/api/0.4/type_by_view_class/
Retrieves a list of all types sorted by view class
Optional Parameters |
|
Type Tree¶
/api/0.4/type_tree/
Shows every type in an OpenAtlas instance in hierarchical order.
Optional Parameters |
|
Administrative Endpoints¶
Provide metadata of the OpenAtlas instance for presentation sites.
Backend Details¶
/api/0.4/backend_details/
Retrieves a detailed list of the OpenAtlas version, the available API versions, site name, image and IIIF details.
Classes¶
/api/0.4/classes/
Retrieves a detailed list of all available system classes, their CIDOC CRM mapping, which view they belong to, which icon is used, and their english name.
Licensed File Overview¶
/api/0.4/licensed_file_overview/
Retrieves a list of display URL, thumbnail URL, extension and license of all files which exists and have a licence. With the parameter “file_id”, only the given IDs where retrieved.
Optional Parameters |
|
System Class Count¶
/api/0.4/system_class_count/
Retrieves a list of the numbers of entries connected to a system class
Special Endpoints¶
Provides project-specific formats.
Export Database¶
/api/0.4/export_database/{format}
Downloads all information in an OpenAtlas instance as CSV, XML, or JSON
Geometric Entities¶
/api/0.4/geometric_entities/
Retrieves a detailed GeoJSON list of all chosen geometries in an OpenAtlas instance; this was implemented for map usage
Optional Parameters |
||