GraphQL API

GraphQL API is a query language for APIs first offered in CollectiveAccess Version 1.8. This API provides a full range of services for reading and writing both catalogue data and system configuration, and is under active development.

URLs

API access in provided through several endpoints, each implementing a category of functionality. The format for GraphQL service URLs is: <base-url>/service/<endpoint-name>, where the base URL is the root URL for your CollectiveAccess install and endpoint is name of a service described below.

If your CollectiveAccess system is at https://www.mysite.com, the URL for the authentication endpoint would be https://www.mysite.com/service/Auth.

Endpoints

• Authentication (endpoint name Auth)
  • JWT configuration options
• Searching (endpoint name Search)
  • Field-level searches using the find query
  • Multiple searches or finds in a single query
  • Record lookup by value using the exists query
  • Limiting results using access values
• Item-level data access (endpoint name Item)
  • Fetching relationships for an item
  • Fetching different relationships for an item in a single query
  • Fetching related media representations
  • Limiting results using access values
• Editing (endpoint name Edit)
  • Creating new records
  • Multiple adds and hierarchies
  • Adding relationships to a new record
  • Matching using other fields
  • Editing records
  • Multiple edits
  • Deleting records
  • Truncating tables
  • Creating relationships
  • Editing relationships
  • Deleting relationships
  • Deleting all relationships:
• Browsing (endpoint name Browse)
  • The key parameter
  • Fetching information about facets
  • Managing browse filter criteria
  • Fetching results
• Lightbox/set management (endpoint name Lightbox)
  • Fetching a list of lightboxes
  • Getting the contents of a lightbox
  • Creating and editing lightboxes
  • Managing order of items in a lightbox
  • Transferring items between lightboxes
  • Sharing lightboxes
  • Commenting on lightboxes
• Schema information (endpoint name Schema)
• Metadata import (endpoint name MetadataImport)
• Configuration (endpoint name Config)
• Utility (endpoint name Utility)