Web Service

Web service layer exposed via a Neo4j extension at path: /ehri

Resources

name path methods description
AdminResource
  • /admin/create-default-user-profile
  • /admin/export-graphson
  • /admin/export-json
  • POST
  • GET
  • GET
Provides additional Admin methods needed by client systems and general graph-maintenance functionality.
AnnotationResource
  • /classes/Annotation
  • /classes/Annotation/{id}
  • GET POST
  • DELETE GET PUT
Web service interface for creating annotations.
AuthoritativeSetResource
  • /classes/AuthoritativeSet
  • /classes/AuthoritativeSet/{id}
  • /classes/AuthoritativeSet/{id}/all
  • /classes/AuthoritativeSet/{id}/eac
  • /classes/AuthoritativeSet/{id}/list
  • GET POST
  • DELETE GET POST PUT
  • DELETE
  • GET
  • GET
Provides a web service interface for the AuthoritativeSet items. model. Authoritative Sets are containers for Historical Agents (authority files.)
BatchResource
  • /batch/delete
  • /batch/update
  • POST
  • PUT
Resource class for import endpoints.
ContentTypeResource
  • /classes/ContentType
  • /classes/ContentType/{id}
  • GET
  • GET
Provides a web service interface for the ContentType model. Note: ContentType instances are created by the system, so we do not have create/update/delete methods here.
CountryResource
  • /classes/Country
  • /classes/Country/{id}
  • /classes/Country/{id}/eag
  • /classes/Country/{id}/list
  • GET POST
  • DELETE GET POST PUT
  • GET
  • GET
Provides a web service interface for managing countries and creating repositories within them.
CvocConceptResource
  • /classes/CvocConcept
  • /classes/CvocConcept/{id}
  • /classes/CvocConcept/{id}/broader
  • /classes/CvocConcept/{id}/list
  • /classes/CvocConcept/{id}/narrower
  • /classes/CvocConcept/{id}/related
  • /classes/CvocConcept/{id}/relatedBy
  • GET
  • DELETE GET POST PUT
  • GET
  • GET
  • DELETE POST
  • DELETE GET POST
  • GET
Provides a web service interface for the Concept model. Note that the concept creation endpoint is part of the VocabularyResource and creation without a Vocabulary is not possible via this API.
DocumentaryUnitResource
  • /classes/DocumentaryUnit
  • /classes/DocumentaryUnit/{id}
  • /classes/DocumentaryUnit/{id}/ead
  • /classes/DocumentaryUnit/{id}/list
  • GET
  • DELETE GET POST PUT
  • GET
  • GET
Provides a web service interface for the DocumentaryUnit model.
GenericResource
  • /entities
  • /entities/{id}
  • /entities/{id}/access
  • /entities/{id}/annotations
  • /entities/{id}/dc
  • /entities/{id}/demote
  • /entities/{id}/descriptions
  • /entities/{id}/events
  • /entities/{id}/links
  • /entities/{id}/permission-grants
  • /entities/{id}/promote
  • /entities/{id}/scope-permission-grants
  • /entities/{id}/versions
  • /entities/{id}/descriptions/{did}
  • /entities/{id}/descriptions/{did}/access-points
  • /entities/{id}/descriptions/{did}/access-points/{apid}
  • GET POST
  • GET
  • GET POST
  • GET
  • GET
  • DELETE POST
  • POST PUT
  • GET
  • GET
  • GET
  • DELETE POST
  • GET
  • GET
  • DELETE PUT
  • POST
  • DELETE
Provides a means of fetching items and lists of items regardless of their specific type.
GroupResource
  • /classes/Group
  • /classes/Group/{id}
  • /classes/Group/{id}/actions
  • /classes/Group/{id}/list
  • /classes/Group/{id}/{aid}
  • GET POST
  • DELETE GET PUT
  • GET
  • GET
  • DELETE POST
Provides a web service interface for the Group model.
HistoricalAgentResource
  • /classes/HistoricalAgent
  • /classes/HistoricalAgent/{id}
  • /classes/HistoricalAgent/{id}/eac
  • GET POST
  • DELETE GET PUT
  • GET
Provides a web service interface for the HistoricalAgent model.
ImportResource
  • /import/csv
  • /import/eac
  • /import/ead
  • /import/ead-sync
  • /import/eag
  • /import/links
  • /import/skos
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
Resource class for import endpoints.
LinkResource
  • /classes/Link
  • /classes/Link/{id}
  • GET POST
  • DELETE GET PUT
Provides a web service interface for creating/reading item links.
PermissionGrantResource
  • /classes/PermissionGrant/{id}
  • DELETE GET
Provides a web service interface for the PermissionGrant model.
PermissionsResource
  • /permissions
  • /permissions/{userOrGroup}
  • /permissions/{userOrGroup}/permission-grants
  • /permissions/{userOrGroup}/item/{id}
  • /permissions/{userOrGroup}/scope/{id}
  • GET
  • GET POST
  • GET
  • GET POST
  • GET POST
Web service resource for setting and reading permissions.
RepositoryResource
  • /classes/Repository
  • /classes/Repository/{id}
  • /classes/Repository/{id}/ead
  • /classes/Repository/{id}/eag
  • /classes/Repository/{id}/list
  • GET
  • DELETE GET POST PUT
  • GET
  • GET
  • GET POST
Provides a web service interface for the Repository.
SystemEventResource
  • /classes/SystemEvent
  • /classes/SystemEvent/{id}
  • /classes/SystemEvent/{id}/subjects
  • GET
  • GET
  • GET
Provides a web service interface for the Event model. Note: Event instances are created by the system, so we do not have create/update/delete methods here.

The following query parameters apply to all actions in this resource to apply filtering to the event streams.

eventTypes
Filter events by type
itemTypes
Filter events based on the item type of their subjects
itemIds
Filter events pertaining to specific item IDs
users
Filter events based on the user IDs they involve
from
Exclude events prior to this date (ISO 8601 format)
to
Exclude events after this date (ISO 8601 format)

Additionally the aggregate* end-points accept an aggregation parameter that groups sequential events according to one of two different strategies:

user
Groups sequential events of all types that are initiated by the same actioner
strict
Groups sequential events that:
  • have the same type
  • have the same actioner
  • have the same subjects
  • have the same scope
  • have the same log message

Additionally, aggregation can be disabled by using aggregation=off.

Standard paging parameters apply to all end-points.

ToolsResource
  • /tools/__INITIALISE
  • /tools/find-replace
  • /tools/full-upgrade-1to2
  • /tools/regenerate-description-ids
  • /tools/regenerate-ids
  • /tools/relink-targets
  • /tools/rename
  • /tools/reparent
  • /tools/schema
  • /tools/set-constraints
  • /tools/set-labels
  • /tools/upgrade-1to2
  • /tools/version
  • /tools/regenerate-ids-for-scope/{scope}
  • /tools/regenerate-ids-for-type/{type}
  • /tools/generate-concepts/{repositoryId}/{vocabularyId}
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
Miscellaneous additional functionality that doesn't fit anywhere else.
UserProfileResource
  • /classes/UserProfile
  • /classes/UserProfile/{id}
  • /classes/UserProfile/{id}/actions
  • /classes/UserProfile/{id}/annotations
  • /classes/UserProfile/{id}/blocked
  • /classes/UserProfile/{id}/events
  • /classes/UserProfile/{id}/followers
  • /classes/UserProfile/{id}/following
  • /classes/UserProfile/{id}/links
  • /classes/UserProfile/{id}/virtual-units
  • /classes/UserProfile/{id}/watching
  • /classes/UserProfile/{id}/is-blocking/{otherId}
  • /classes/UserProfile/{id}/is-follower/{otherId}
  • /classes/UserProfile/{id}/is-following/{otherId}
  • /classes/UserProfile/{id}/is-watching/{otherId}
  • GET POST
  • DELETE GET PUT
  • GET
  • GET
  • DELETE GET POST
  • GET
  • GET
  • DELETE GET POST
  • GET
  • GET
  • DELETE GET POST
  • GET
  • GET
  • GET
  • GET
Provides a web service interface for the UserProfile.
VersionResource
  • /classes/Version/{id}
  • GET
Web-service interface for accessing item versions.
VirtualUnitResource
  • /classes/VirtualUnit
  • /classes/VirtualUnit/{id}
  • /classes/VirtualUnit/{id}/includes
  • /classes/VirtualUnit/{id}/list
  • /classes/VirtualUnit/{from}/includes/{to}
  • GET POST
  • DELETE GET POST PUT
  • DELETE GET POST
  • GET
  • POST
Provides a web service interface for the VirtualUnit type
VocabularyResource
  • /classes/CvocVocabulary
  • /classes/CvocVocabulary/{id}
  • /classes/CvocVocabulary/{id}/all
  • /classes/CvocVocabulary/{id}/export
  • /classes/CvocVocabulary/{id}/list
  • GET POST
  • DELETE GET POST PUT
  • DELETE
  • GET
  • GET
Provides a web service interface for the Vocabulary model. Vocabularies are containers for Concepts.