Ontologie Modules API
Ontologie Modules API
API for the functional modules powering Ontologie: Spreadsheets, Dashboard, Calendar, Knowledge Library, Governance, Object Instances, Scenarios, and Alerts.
Authentication
All endpoints require an API key and workspace ID:
curl -X GET "https://api-app.growthsystemes.com/api/spreadsheets" \
-H "X-API-Key: your-api-key" \
-H "X-Workspace-Id: your-workspace-uuid"
Modules
| Module | Description |
|---|---|
| Spreadsheets | Collaborative spreadsheets with natural language queries |
| Dashboard | Workspace analytics, KPIs, and custom dashboards |
| Calendar | Multi-calendar event management with RRULE recurrence |
| Knowledge | Document ingestion, RAG pipeline, and semantic search |
| Governance | Approval workflows, data classification, lineage, and quality |
| Instances | Object type instances (digital twin data layer) |
| Scenarios | COW scenario modeling with BFS impact analysis |
| Alerts | Condition-based alerting with multi-channel dispatch |
Authentication
- API Key: apiKey
- API Key: workspaceId
API key for external integrations. Get yours at Settings > API Keys.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
Workspace UUID. Required for multi-tenant operations.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Workspace-Id |
License
Enterprise
📄️ Acknowledge alert instance
Acknowledge an active alert to indicate it has been seen.
📄️ Add attendee
Add an attendee to a calendar event.
📄️ Approve governance request
Approve a pending governance request. Requires governance.approve and does not imply governance.view.
📄️ Assign role to user
Assign a custom role to a user. Requires settings.admin permission.
📄️ Bulk create instances
Create multiple instances of an object type in a single transaction.
📄️ Cancel governance request
Cancel a governance request created by the current user. Requires governance.edit.
📄️ Check connection quota
Check if adding a new connection is within the current quota limits.
📄️ Check permission
Check if the current user holds a specific permission or resource access level.
📄️ Check sync quota
Check if a sync operation is within the current quota limits before execution.
📄️ Apply classification to instance
Apply a classification to an instance or property path. Requires governance.edit.
📄️ Cleanup expired data
Trigger a manual cleanup of expired data according to the configured retention policies.
📄️ Compare two scenarios
Compare the changes between two scenarios to identify differences and overlaps.
📄️ Create access policy
Create a governance access policy. Requires governance.admin.
📄️ Create approval policy
Create a new governance approval policy. Requires governance.admin.
📄️ Create event
Create a new calendar event. Supports all-day events, recurrence rules (RFC 5545 RRULE), and attendees.
📄️ Create calendar
Create a new calendar in the workspace.
📄️ Create classification definition
Create a classification definition. Requires governance.admin.
📄️ Create dashboard
Create a new custom dashboard with configurable widgets and layout.
📄️ Create source
Create a new document ingestion source for automatic document import.
📄️ Create a feature flag
Create a new feature flag with optional targeting rules for conditional activation.
📄️ Create instance edge
Create a relationship edge between two instances.
📄️ Create library template
Create a new library template for reusable ontology components.
📄️ Create instance
Create a new instance of an object type. Properties are validated against the object type schema. Dual-writes to JSONB and relational stores.
📄️ Create a procurement source
Create a new procurement data source for fetching public tenders.
📄️ Create quality health check
Create a new health check definition. Requires governance.admin.
📄️ Create quota override
Admin endpoint to create a quota override for a workspace, allowing temporary or permanent limit adjustments.
📄️ Create role
Create a custom role. Requires settings.admin permission.
📄️ Create a saved view
Create a new saved view for an object type with filter, column, and sort configurations.
📄️ Create scenario template
Create a reusable scenario template from an existing scenario.
📄️ Create scenario (COW snapshot)
Create a new scenario with a copy-on-write snapshot of the current ontology state.
📄️ Create temporal simulation
Create and run a temporal simulation based on a scenario with time-series projections.
📄️ Create source-linked spreadsheet
Create a new spreadsheet linked to an external data source for auto-population.
📄️ Create form
Create a new form linked to a spreadsheet for data entry.
📄️ Create tab
Add a new tab to an existing spreadsheet.
📄️ Create tag
Create a new workspace-level spreadsheet tag.
📄️ Create spreadsheet
Create a new spreadsheet in the workspace.
📄️ Create workspace
Create a new workspace with the specified name, description, and settings.
📄️ Delete approval policy
Soft-delete an approval policy. Requires governance.admin.
📄️ Delete event
Delete a calendar event. For recurring events, this deletes the entire series.
📄️ Delete calendar
Delete a calendar and all its events. The default calendar cannot be deleted.
📄️ Delete classification definition
Delete a classification definition. Requires governance.admin.
📄️ Delete dashboard
Delete a custom dashboard and all its widgets.
📄️ Delete document
Delete a document and its associated chunks, embeddings, and entity links.
📄️ Delete a feature flag
Delete a feature flag by name. This action cannot be undone.
📄️ Delete instance edge
Delete a relationship edge between instances.
📄️ Delete library template
Delete a library template. This action is irreversible.
📄️ Delete instance
Delete an object instance and its associated edges.
📄️ Delete quality health check
Delete a health check definition. Requires governance.admin.
📄️ Delete resource ACL entry
Remove a specific ACL entry from a resource. Requires settings.admin permission.
📄️ Delete role
Delete a custom role. Requires settings.admin permission.
📄️ Delete a saved view
Delete a saved view and remove all associated shares.
📄️ Delete scenario
Delete a scenario and its COW snapshot data.
📄️ Delete tab
Remove a tab from a spreadsheet.
📄️ Delete spreadsheet
Soft-delete a spreadsheet and all its tabs.
📄️ Delete user override
Remove a specific permission override for a user. Requires settings.admin permission.
📄️ Delete workspace
Delete a workspace and all associated data. This action is irreversible.
📄️ Duplicate dashboard
Create a copy of an existing dashboard including all widgets and layout.
📄️ Duplicate scenario
Create a copy of an existing scenario including its COW snapshot.
📄️ Estimate credit cost
Estimate the credit cost for a given operation without executing it.
📄️ Export instances CSV
Export all instances of an object type as a CSV file.
📄️ Export tenders as CSV
Export all matching tenders as a CSV file for offline analysis.
📄️ Find similar documents
Find documents similar to the given document using vector similarity search.
📄️ Get alert instance events
Retrieve event history for an alert instance.
📄️ Get alert instance details
Retrieve a single alert instance by ID.
📄️ Get alert statistics
Aggregate alert statistics by status and severity.
📄️ Get governance request
Retrieve one governance request with its decision history. Requires governance.view.
📄️ Get compliance audit trail
Retrieve the compliance audit trail with filtering by date range, user, and action type.
📄️ Get bundle import status
Get the current status of a bundle import operation.
📄️ Get bundle
Retrieve bundle details and a summary of its contents.
📄️ Get event
Retrieve a single calendar event by ID.
📄️ Get calendar
Retrieve a single calendar by ID.
📄️ Get catalog staleness report
Retrieve freshness SLA status for the governance catalog. Requires governance.view.
📄️ Get compliance data lineage for entity
Retrieve the complete data lineage graph for a specific entity, showing data flow, transformations, and dependencies.
📄️ Get compliance health check
Run a compliance health check to verify that retention policies, audit trails, and data protection measures are functioning correctly.
📄️ Get credit balance
Retrieve the current credit balance for the workspace.
📄️ Get dashboard
Retrieve a single custom dashboard by ID including all widgets and layout.
📄️ Recent activity
Retrieve the most recent workspace activity feed including entity changes, user actions, and system events.
📄️ KPI metrics
Retrieve key performance indicators for the workspace including data quality scores and usage metrics.
📄️ Source overview
Get an overview of all connected data sources and their current sync status.
📄️ Get workspace stats
Retrieve aggregate workspace statistics including node/edge counts, recent activity metrics, and growth indicators.
📄️ Get instance lineage
Retrieve upstream and downstream lineage for one instance. Requires governance.view.
📄️ Get document chunks
Retrieve the text chunks generated from a document after the chunking stage of the RAG pipeline.
📄️ Get linked entities
Retrieve ontology entities that have been linked to a document through the entity linking pipeline stage.
📄️ Get document
Retrieve a single document by ID including its metadata and processing status.
📄️ Documents for entity
Retrieve all knowledge documents linked to a specific ontology entity.
📄️ Get feature flag audit history
Retrieve the audit history for a specific feature flag, showing all changes over time.
📄️ Get a feature flag by name
Retrieve a single feature flag by its unique name, including rules and audit metadata.
📄️ Get geospatial features
Retrieve GeoJSON features for map display with optional bounding box filtering and zoom-dependent clustering.
📄️ Get spatially related entities
Find entities that are spatially related to a given entity based on proximity or containment.
📄️ Get geospatial statistics
Retrieve geospatial statistics including coverage area, entity counts, and data freshness.
📄️ Get geospatial timeline
Retrieve a timeline of geospatial events for temporal map visualization.
📄️ Get geospatial tracks
Retrieve movement tracks with time range filtering for entity tracking on map.
📄️ Get instance edges
Retrieve all edges (relationships) connected to an instance.
📄️ Knowledge analytics
Retrieve analytics for the knowledge library including document counts, chunk statistics, and search performance metrics.
📄️ Get library template
Retrieve full details of a library template including its content.
📄️ Get instance
Retrieve a single object instance by ID with all its properties.
📄️ Get object type lineage graph
Retrieve the lineage graph for one object type. Requires governance.view.
📄️ Get permissions summary
Get a summary of the workspace permission state for use in dashboard widgets.
📄️ Get advanced procurement analytics
Retrieve advanced procurement analytics including trend analysis, score distributions, and buyer breakdowns.
📄️ Get procurement analytics summary
Retrieve a summary of procurement analytics including total tenders, average scores, and value distribution.
📄️ Get procurement preferences
Retrieve the workspace procurement preferences including scoring criteria and notification settings.
📄️ Get property lineage
Retrieve provenance for one property on an instance. Requires governance.view.
📄️ Get quality dashboard
Retrieve quality score aggregates for catalog entries. Requires governance.view.
📄️ Get quality health check results
Retrieve recent results for one health check. Requires governance.view.
📄️ Get quota history
Get quota usage history over a time period with aggregation.
📄️ Get quota status
Get the current quota status for the workspace including usage and limits.
📄️ Get quota usage statistics
Get a detailed breakdown of quota usage statistics by category.
📄️ Get resource permissions by user
Get all resource ACLs affecting a specific user (direct assignments + via role).
📄️ Get resource ACL
Get all ACL entries for a specific resource.
📄️ Get role permissions
Get all permissions assigned to a role.
📄️ Get a saved view
Retrieve a single saved view by ID with its full configuration.
📄️ BFS impact analysis
Run a BFS impact analysis to determine which entities would be affected by the scenario changes.
📄️ Get scenario details
Retrieve a single scenario by ID including its COW change records.
📄️ Get simulation results
Retrieve the results of a completed temporal simulation including time-series data.
📄️ Get spreadsheet data
Retrieve row data from a spreadsheet with optional tab filtering and pagination.
📄️ Get tags for spreadsheet
Retrieve tags associated with a specific spreadsheet.
📄️ Get spreadsheet
Retrieve a single spreadsheet by ID including its tabs and metadata.
📄️ Get tender geographic stats
Retrieve geographic distribution statistics for tenders, aggregated by region.
📄️ Get a tender by ID
Retrieve a single procurement tender by ID with full details and scoring breakdown.
📄️ Get user effective permissions
Get the resolved effective permission set for a user (roles + overrides merged).
📄️ Get user overrides
Get all permission overrides (grants and denies) for a specific user.
📄️ Get vector tile
Retrieve a Mapbox Vector Tile (MVT) for a specific layer and tile coordinates.
📄️ Get workspace statistics
Retrieve workspace usage statistics including member count, storage, and resource counts.
📄️ Get workspace
Retrieve workspace details by ID including settings and metadata.
📄️ Import bundle
Import a bundle into the workspace, creating all contained resources.
📄️ Import library template
Import a template from an external source or registry into the library.
📄️ Invite workspace member
Add a workspace member by existing user ID or by email. When only an unknown email is provided, an Auth invitation email is sent and the membership is created in the workspace.
📄️ Check if a feature flag is enabled
Check whether a specific feature flag is enabled for the current workspace context. Evaluates targeting rules if configured.
📄️ Question answering with citations
Ask a natural language question and receive an answer grounded in the knowledge library with source citations. Uses Corrective RAG (CRAG) for multi-hop queries.
📄️ List access policies
Retrieve governance access policies. Requires governance.view.
📄️ List alert instances
Retrieve alert instances in the workspace with optional filtering by status and severity.
📄️ List approval policies
Retrieve approval workflow policies for the current workspace. Requires governance.view.
📄️ List governance requests
Retrieve governance approval requests. Requires governance.view.
📄️ List bundles
List available bundles with optional pagination.
📄️ List events
Retrieve calendar events with optional filtering by calendar, date range, and pagination. Recurring events are expanded into virtual instances within the requested range.
📄️ List calendars
Retrieve all calendars in the current workspace.
📄️ List catalog entries
Browse governance catalog entries with optional tag filtering. Requires governance.view.
📄️ List classification definitions
Retrieve classification definitions for the workspace. Requires governance.view.
📄️ List credit packs
List all available credit packs for purchase.
📄️ List credit transactions
List credit transactions for the workspace with pagination support.
📄️ List custom dashboards
Retrieve all custom dashboards created in the workspace.
📄️ List widgets
List all widgets configured on a custom dashboard.
📄️ List document sources
List all configured document ingestion sources (connectors, URLs, etc.).
📄️ List documents
Retrieve all documents in the knowledge library with optional filtering by source type and status.
📄️ List attendees
List all attendees of a calendar event.
📄️ List reminders
List all reminders configured for a calendar event.
📄️ List all feature flags
Retrieve all feature flags configured in the workspace with their current states and rules.
📄️ List instance classifications
Retrieve classifications applied to one instance. Requires governance.view.
📄️ List library templates
List available library templates with optional pagination and category filtering.
📄️ List instances of an object type
Retrieve all instances of a specific object type with optional filtering and pagination. Supports dual-store reads (JSONB + relational).
📄️ List permission definitions
List all 36 static permission definitions (no workspace context required).
📄️ List procurement sources
Retrieve all configured procurement data sources for the workspace.
📄️ List procurement sync runs
Retrieve the history of procurement source synchronization runs with status and statistics.
📄️ List quality health checks
List health check definitions. Requires governance.view.
📄️ List quarantined items
List quarantined instances. Requires governance.view.
📄️ List quota tiers
List all available quota tiers with their limits and pricing.
📄️ List data retention policies
Retrieve all configured data retention policies for the workspace, including schedules and affected data types.
📄️ List roles
List all roles for the current workspace (system + custom).
📄️ List saved views for an object type
Retrieve all saved views for a specific object type, including shared views visible to the current user.
📄️ List scenario templates
List available scenario templates for quick creation.
📄️ List scenarios
Retrieve all scenarios in the workspace with optional status filtering.
📄️ List available solvers
List all available solver algorithms for optimization problems.
📄️ List source-linked spreadsheets
List spreadsheets that are linked to external data sources.
📄️ List forms
List all forms associated with a spreadsheet.
📄️ List tabs
List all tabs within a spreadsheet.
📄️ List spreadsheets
Retrieve all spreadsheets in the current workspace with optional pagination.
📄️ List procurement tenders
Retrieve all tenders in the workspace with optional filtering and pagination.
📄️ List workspace members
List all members of a workspace with their assigned roles and identity details when available from Auth.
📄️ List workspace tags
List all unique spreadsheet tags across the workspace.
📄️ List workspaces
List all workspaces accessible to the current user with optional pagination.
📄️ Merge scenario changes
Merge scenario COW changes back into the main ontology state. Validates conflicts before applying.
📄️ Ontologie Modules API
# Ontologie Modules API
📄️ Preview bundle import
Preview the effects of importing a bundle into the workspace without applying changes.
📄️ Preview spreadsheet
Get a lightweight preview of a spreadsheet (first few rows and column headers).
📄️ Purchase credits
Purchase a credit pack for the workspace.
📄️ Reject governance request
Reject a pending governance request. Requires governance.approve and does not imply governance.view.
📄️ Release quarantined instance
Release an instance from quarantine. Requires governance.edit.
📄️ Remove attendee
Remove an attendee from a calendar event.
📄️ Remove instance classification
Remove a classification from an instance or property path. Requires governance.edit.
📄️ Remove role from user
Remove a custom role from a user. Requires settings.admin permission.
📄️ Remove workspace member
Remove a member from the workspace. The workspace owner cannot be removed.
📄️ Request GDPR data export
Request a GDPR-compliant data export for a user. The export is processed asynchronously and a download link is provided upon completion.
📄️ Request right to be forgotten
Submit a GDPR right to be forgotten request. This will anonymize or delete all personal data associated with the specified user.
📄️ Rescore all tenders
Rescore all tenders in the workspace using the current scoring criteria and preferences.
📄️ Resolve alert instance
Mark an alert instance as resolved.
📄️ Revoke view share
Revoke a specific view share, removing access for the associated user.
📄️ Rollback bundle import
Rollback a completed bundle import, removing all resources that were created.
📄️ Run all quality health checks
Run all health checks for one object type. Requires governance.edit.
📄️ Run quality health check
Run one health check manually. Requires governance.edit.
📄️ Run solver optimization
Execute a solver algorithm to find optimal parameter values for a given objective function.
📄️ Score tenders against criteria
Score a set of tenders against the configured scoring criteria and preferences.
📄️ Search documents
Hybrid search across the knowledge library using 4 sources (vector, lexical FTS, graph entities, title ILIKE) with RRF fusion and optional ColBERT reranking.
📄️ Search instances
Search instances of an object type using JSONB property filters and full-text search.
📄️ Search tenders with filters
Search tenders using full-text search, date ranges, value ranges, and advanced filters.
📄️ Set default view for object type
Set the default saved view for an object type. The previous default view will be unset.
📄️ Set reminder
Add or update a reminder for a calendar event. Processed via BullMQ calendar-reminders queue.
📄️ Set resource ACL entry
Grant a user or role access to a specific resource. Requires settings.admin permission.
📄️ Set role permissions
Replace the full permission set for a role. Requires settings.admin permission.
📄️ Set user override
Grant or deny a specific permission for a user. Requires settings.admin permission.
📄️ Share a view with users
Share a saved view with one or more users in the workspace, granting them read access.
📄️ Sync with Google Calendar
Initiate a bidirectional sync with Google Calendar using OAuth2 credentials.
📄️ Sync with Outlook
Initiate a bidirectional sync with Microsoft Outlook Calendar using OAuth2 credentials.
📄️ Sync a procurement source
Trigger an immediate synchronization of a procurement source to fetch new tenders.
📄️ Transfer workspace ownership
Transfer ownership of the workspace to another member. Only the current owner can perform this action.
📄️ Update approval policy
Update an approval policy. Requires governance.admin.
📄️ Update event
Update an existing calendar event. For recurring events, this updates the series definition.
📄️ Update calendar
Update calendar name, color, timezone, or default status.
📄️ Update catalog entry
Create or update catalog metadata for one object type. Requires governance.edit.
📄️ Update dashboard
Update dashboard name, description, or layout configuration.
📄️ Update widgets
Replace all widgets on a dashboard with the provided configuration.
📄️ Update a feature flag
Update a feature flag description, enabled state, scope, or targeting rules.
📄️ Update library template
Update an existing library template name, description, category, or content.
📄️ Update member role
Update the role assigned to a workspace member.
📄️ Update instance
Update instance properties or status. Partial updates are supported.
📄️ Update procurement preferences
Update workspace procurement preferences including scoring criteria, regions, and notification settings.
📄️ Update a procurement source
Update an existing procurement source configuration.
📄️ Update quality health check
Update a health check definition. Requires governance.admin.
📄️ Update role
Update a custom role. Requires settings.admin permission.
📄️ Update a saved view
Update an existing saved view configuration including filters, columns, sort, and name.
📄️ Update scenario
Update scenario name, description, or status.
📄️ Update spreadsheet data (batch)
Batch update rows in a spreadsheet. Supports insert, update, and delete operations.
📄️ Update tab
Update tab name or column definitions.
📄️ Update spreadsheet tags
Replace the tags associated with a spreadsheet.
📄️ Update spreadsheet
Update spreadsheet name, description, or other metadata.
📄️ Update workspace tier
Admin endpoint to update the quota tier for a specific workspace.
📄️ Update workspace
Update workspace name, description, or settings.
📄️ Upload bundle
Upload a new bundle file using multipart/form-data.
📄️ Upload document
Upload a document to the knowledge library. Triggers the 6-stage RAG ingestion pipeline (extract, chunk, embed, tree, entity link, graph).
📄️ Use library template
Apply a library template to create resources in the current workspace.
📄️ Validate bundle
Validate the structure and integrity of a bundle without importing it.