Skip to main content

GraphQL Content API (GCA)

The GCA is the one-stop shop for interacting with your Brightspot instance via web APIs.

The GCA has 4 core competencies, which together encompass nearly everything that's possible within the Java SDK. They are:

  • Queries
  • Content Management
  • View Rendering
  • Custom Methods

Queries​

Mirrors the Dari Query API, maintaining parity with its robust type system and field definitions, enabling precise and efficient data retrieval.

  • Dynamic Query#from
  • Complex predicate / sort
  • Content URL resolution
  • Customizable field access
  • Type System Parity
  • Raw state access

Content Management​

Programmatic access to key CMS functions including the full content lifecycle and access to enhanced metadata for any content type.

  • Full Workflow Lifecycle
  • Access Revision History
  • Derivations (Translation)
  • Overlays (Segmentation)
  • Preview
  • Transactions

View Rendering​

  • Unified Request Params
  • Access to View Response
  • Real-Time Preview
  • Complex Theme Metadata
  • Access to backing Model
  • View Model Overlays

Custom Methods​

Embodies the API-First philosophy and automatically integrates directly with Java APIs minimizing redundant development efforts.

  • Execute Static Methods
  • Access Non-Getter Instance Methods
  • Direct Platform API Access
  • Reduced dependence on View System for custom business logic