Skip to content

API Design

mark-bell-tna edited this page May 17, 2023 · 9 revisions

Hierarchy of data

API entities and filter properties

Entity Properties
Agent name
Place name, coordinates
Event name, from date, to date
Object name

API entity associations and examples

Each entity type may have properties which are one of the other entity types. Some examples are in the following table.

. Agent Place Event Object
Agent Name Place of residence Date of birth Medal
Place Mayor Name Founded Statue
Event Involved Happened at Name x
Object Belonged to Made at Sold Name

Example queries and response types

Q1. Which archives uploaded new records last week?

  • Select Entities of type Document
  • Select those with Event name = 'Created' and Date during last week
  • Find archives those Documents are held in
  • Return unique list of Ids and names of archives
Clone this wiki locally