Common patterns

Across all CONNECT services, several common patterns are employed to ensure consistency and usability.

Data retrieval patterns

CONNECT provides multiple approaches to data access, accommodating different use cases and performance requirements:

• Direct value access via stream IDs and indices.

• Range-based queries with start/end index.

Interpolation for calculating values at specific points.

• Sampling for evenly spaced data points.

• Bulk operations for efficiency.

Security model

A comprehensive security approach ensures data protection and appropriate access controls:

• OAuth2 Bearer token authentication.

• Resource-level authorization via security tags.

• Operation-specific permissions.

Pagination and large result handling

CONNECT implements strategies to efficiently work with large datasets:

• Skip/count parameters for basic pagination.

• Continuation tokens for stateful iteration through large result sets.

Error handling

A standardized approach to error reporting provides clear guidance for troubleshooting:

• Consistent error response format using Problem Details.

• HTTP status codes with detailed error information.

• Multi-status (207) responses for batch operations with partial success.

This API architecture provides a unified approach to industrial data management while maintaining the flexibility needed for diverse industrial applications ranging from real-time monitoring to advanced analytics.