Introduction to GraphQL
The Textura Data-as-a-Service (DaaS) application uses GraphQL, a modern API query language that is an alternative to REST.
GraphQL key concepts:
- Single Endpoint: Unlike REST, which uses multiple URLs for different resources, GraphQL uses a single endpoint for all data requests. The DaaS URI for all queries is /api/graphql.
- Flexible Queries: Clients customize queries to specify exactly what data they need to support dashboards, reports, or bulk data extracts from the DaaS API.
- Strongly Typed Schema: Every GraphQL API is defined by a schema outlining data types and relationships. This gives you clear schema documentation and helps prevent errors.
- Introspective: An introspection query of the API returns a representation of its schema, enabling integration to clients like postman or AI agents.
While GraphQL offers flexibility, it can present a challenge for users unfamiliar with its query structure or the underlying TPM data model. This guide assists customers write effective DaaS queries. Customers must complete onboarding before testing any queries.