Export Connections - OData API

JustPerform exposes its data through a standardized OData API, enabling external systems to consume planning and consolidation data. This allows for seamless integration with BI tools, custom applications, and other enterprise systems.

v25.12: You can expose OData snippets via OData services by referencing their Technical ID, and export the report via API. For how to create OData snippets, see OData Snippets.

Enabling OData Export

Enable OData Service
1. Navigate to System Administration
2. Select API Configuration
3. Enable OData Service
4. Configure service endpoint URL
Define Exposed Entities
1. Select data models to expose
2. Choose specific tables/views
3. Set field-level permissions
4. Configure relationships
Set Access Permissions
1. Define read/write permissions
2. Configure entity-level security
3. Set row-level security rules
4. Enable query restrictions

API Configuration

Service Endpoints

Service Endpoint: https://<API-justperform-instance>/justperform/Workspace/odata/$metadata
Metadata URL: https://<API-justperform-instance>/odata/SheetNames

Authentication Methods

API Key Authentication

Generate API keys per consumer
Set expiration policies
Monitor usage per key

OAuth 2.0

Configure OAuth provider
Set up client applications
Define scopes and permissions

SSO Integration

Leverage existing SSO
Map user permissions
Session-based access

Best Practices for Consumers

Parameter	Best Practices for Consumers
Efficient Querying	Use $select to limit fields Apply appropriate filters Implement pagination Cache frequently accessed data
Error Handling	Handle rate limit responses Implement retry logic Log failed requests Monitor error patterns
Performance Optimization	Use batch operations Minimize round trips Compress requests/responses Implement connection pooling