Graphql schema documentation

Introduction text

link GraphQL Schema definition

  • schema {
  • # Querying retrieves data (read access). Batching of multiple queries is not
  • # supported with this API.
  • #
  • # To modify data or perform operations @see
  • # target="_self">Mutation defintion.
  • #
  • #
  • #
  • # As of GraphQL nature, for each query you need to specify fields returned. To
  • # make this simpler you may use predefined fragments of data (default datasets)
  • #
  • # which honor the _<ObjectName> convention. You may combine predefined
  • # fragments with specific field enumeration in your queries.
  • #
  • # @see fragments.graphql
  • #
  • #
  • #
  • # You may need to distinguish between cursors i.e. pageable lists of items
  • # (SomeobjectList objects) returned and simple sets of items
  • #
  • # (array of objects). General rule is that lists are used for 'content generated
  • # by public' and are retrieved by getObjectList queries,
  • #
  • # simple sets are used for 'items created/managed by administrator' and retrieved
  • # by listObjects calls.
  • #
  • #
  • #
  • # Please note for cursors you may not request more than 30 items at once (i.e.
  • # page size is limited to max. 30 items).
  • #
  • # Querying retrieves data (read access).
  • query: Query
  • # set of methods and entities to create and/or modify entities with this API.
  • mutation: Mutation
  • }