Content Services GraphiQL
GraphiQL is an in-browser integrated development environment for exploring and interacting with the Content Services GraphQL API. The API provides a schema and an easy-to-understand query language that simplifies developing applications for your Content Platform Engine.
The API schema definition of types and fields matches the Content Platform Engine Java™ API object model closely. It also includes extensions for natural GraphQL developer consumption.
The feature set focuses on end-user runtime support, including the following operations:
- Metadata discovery
- Class descriptions and their subclasses, property descriptions, choice lists
- Document and folder operations
-
- Create, read, update, and delete (CRUD) operations:
- Change class
- Update properties
- Update permissions: Access-control lists (ACLs), access-control entries (ACEs), delegated permissions, role permissions
- Object type-specific operations:
- Document: Content upload and download, check in and check out, versioning, and cancel document check out
- Folder: Document file in and out
- Search and query:
- Matches the
Content Engineobject model closely - Metadata search and full text search
- Matches the
- Create, read, update, and delete (CRUD) operations:
- Browse
- Query subfolders and documents in a folder hierarchy:
- Obtain folders and documents by selecting fields corresponding to the Content Platform Engine properties that return these objects. Alternatively, you can use the SQL-like search API, which includes filter and sort criteria.
- Support for columns and properties for returning in the list based on data shaping.
- Paging and sorting.
For more information about working with the Content Services GraphQL API, see Content Services GraphQL Development in the IBM® FileNet® P8 Platform documentation.