Version 0.2¶
Entity endpoint¶
Single entities
API endpoint |
Possible parameters |
Description |
|---|---|---|
/api/0.2/entity/{id} |
show, download,export,format |
Retrieves all information about a single entity |
Query - Combine several or all entity endpoints in one query
API endpoint |
Possible parameters |
Description |
|---|---|---|
/api/0.2/query/ |
ids, cidoc_classes, view_classes, system_classes, limit, column, sort, search, first, last, show, relation_type, type_id, count, download, format, export, page |
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; Possible parameters are: ?entities={id}, ?classes={cidoc_class_code}, ?codes={view_name}, ?system_classes={system_class}(2) |
- Multiple entities - Results in list form include related entities and
pagination
API endpoint |
Possible parameters |
Description |
|---|---|---|
/api/0.2/class/{cidoc_class} |
limit, column, sort, search, first, last, show, relation_type, type_id, count, download, format, export, page |
Retrieves a list of entities, based on their CIDOC CRM class code, including results and pagination key (1)(2) |
/api/0.2/code/{view_class} |
limit, column, sort, filter, first, last, show, count, download, format, export, page |
Retrieves a list of entities, based on their OpenAtlas view name |
/api/0.2/system_class/{system_class} |
limit, column, sort, search, first, last, show, relation_type, count, download, format, export, page |
Retrieves a list of entities, based on their OpenAtlas system class name |
/api/0.2/latest/{n} (n represents a number between 1 and 100) |
show, relation_type, download, format, export |
Retrieve the last entered entities. n represents the amount of entities retrieved (between 1 and 100). The pagination information is always null |
/api/0.2/entities_linked_to_entity/{id} |
limit, column, sort, search, first, last, show, relation_type, type_id, count, download, format, export, page |
Retrieves a list of entities linked to the entity with the stated ID (2) |
/api/0.2/node_entities/{id} |
limit, column, sort, search, first, last, show, relation_type, type_id, count, download, format, export, page |
Retrieves list of entities, based on their OpenAtlas type (2)(3) |
/api/0.2/node_entities_all/{id} |
limit, column, sort, search, first, last, show, relation_type, type_id, count, download, format, export, page |
Retrieves a list of entities, based on their OpenAtlas type and includes all connected entities (2)(3) |
(1) All codes available in OpenAtlas can be found under OpenAtlas and CIDOC CRM class mapping (2) The result can be filtered, sorted, and manipulated through different parameters. By default 20 entities in alphabetical order are shown. (3) Available IDs can be obtained by using the type-tree or node-overview endpoint. Required parameters are shown as bold.
Nodes endpoints¶
API endpoint |
Possible parameters |
Description |
|---|---|---|
/api/0.2/type_by_view_class/ |
download |
Retrieves a list of all types sorted by view class |
/api/0.2/type_tree/ |
Retrieves a detailed list of all OpenAtlas types, including any of their children |
|
/api/0.2/node_entities/{id} |
Retrieves a list of entity names, IDs, and URLs, based on their OpenAtlas type(4) |
|
/api/0.2/node_entities_all/{id} |
Retrieves a list of entity names, IDs, and URLs, based on their OpenAtlas type(4) |
|
/api/0.2/node_overview/ |
Has been modified to /api/type_overview/ |
(4) Note: “Historical Place” and “Administrative Units” cannot be retrieved in this way.
Content endpoints¶
API endpoint |
Possible parameters |
Description |
|---|---|---|
/api/0.2/classes/ |
none |
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 |
/api/0.2/content/ |
download, lang |
Retrieves a detailed list of information on available content in an OpenAtlas instance - intro, legal notice, contact, and size of processed images |
/api/0.2/geometric_entities/ |
count, download |
Retrieves a detailed GeoJSON list of all chosen geometries in an OpenAtlas instance; this was implemented for map usage |
/api/0.2/system_class_count/ |
none |
Retrieves a detailed list of the numbers of entries connected to a system class |
Subunit endpoints¶
API endpoint |
Possible parameters |
Description |
|---|---|---|
/api/0.2/subunit/{id} |
count, download, format |
Retrieves a list of the given place and all of its subunits, provided in a format used by the THANADOS project (THANADOS output format). With the format=xml parameter, a XML can be created. Takes only a valid place ID (E18) as parameter |
/api/0.2/subunit_hierarchy{id} |
Retrieves a list of entity names, IDs, and URLs based on an entity’s ID including all subunits |
Image endpoints¶
API endpoint |
Possible parameters |
Description |
/api/0.2/display/{id} |
Provides the image connected to the requested ID. Be aware, the image will only be displayed if the request comes from a logged-in user or API public setting is set to on and the image has a license |