Feature #2450
closed
API: Custom endpoint for presentation sites
Description
for the detail views in the frontends (for example: https://openatlas-discovery-demo.acdh-ch-dev.oeaw.ac.at/en/visualization?mode=map&selection=128117) we need an specific endpoint that simplifies the structure of the current data model.
per system class we want to implement a custom detail view, so that the related data is displayed individually and so more readable.
currently we use the /entity/{id} and /entities_linked_to_entity/{id} endpoints and merge their relations in the frontend.
still some relations (like actors or events in a place detail view) are not returned.
further requirements would be:
- include the related entities types
Files
Updated by Alexander Watzinger 12 months ago
- Status changed from New to Assigned
Updated by Alexander Watzinger 12 months ago
Thank you Olivia and Katharina for starting this issues. We just talked with Christoph and got a lot good input from him too.
Best would be to sit down together (Olivia, Katharina, Bernhard and Christoph) to discuss general strategies how to deal with API requests for presentation sites.
Updated by Bernhard Koschiček-Krombholz 12 months ago
Thank you for your feedback.
/entities_linked_to_entity/ should also return the entity itself. I will implement this, so you only need one call.
For the further abstraction of the data model, we need another plan. Either we use the Linked Places Format and "fork" it, or we create a completely new JSON output format better suited for presentation sites, which is not bases on a LOD standard. This would be my preferred way because we overloaded LPF quite a lot and still got not everything you need.
Nevertheless, a in person meeting would be great to discuss this. I will reach out to you.
Updated by
Updated by Bernhard Koschiček-Krombholz 11 months ago
A new endpoint will be created under the proposal tag to get information about one entity for the presentation site. This should expose all the needed information about the entity and all linked or relevant other entities.
I will start to implement the API.json for the new endpoint. After that, we will go through different use cases to see if everything is covered.
Updated by Alexander Watzinger 11 months ago
- Subject changed from API: Custom endpoint for entity detailviews in the presentation sites to API: Custom endpoint for presentation sites
Updated by Bernhard Koschiček-Krombholz 11 months ago
- Status changed from Assigned to Closed
I made a custom endpoint names /entity_presentation_view/{entityId} with the respective template. The OpenAPI definition should also up to date.
One further suggestion, we should also put the references into an own special field, because the "relation" to a reference is also the same, and the information needed from a reference is lesser than from other entities.
Please test it. I will make a new ticket for improvement suggestions.
Changes are in develop.
Updated by Bernhard Koschiček-Krombholz 11 months ago
- Related to Feature #2479: API: 0.4.6 added