| title |
Contract |
| description |
Contract protocol schemas |
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
Machine-readable semantic code (ADR-0112): a StandardErrorCode member or
a code registered in ERROR_CODE_LEDGER. A closed set on purpose — an
unregistered code fails parse, so the envelope conformance suites catch
invented codes instead of letting a new dialect grow (#3841).
**Source:** `packages/spec/src/api/contract.zod.ts`
import { ApiError, BaseResponse, BatchLoadingStrategy, BulkRequest, BulkResponse, CreateRequest, DataLoaderConfig, DeleteResponse, ExportRequest, IdRequest, ListRecordResponse, ModificationResult, QueryOptimizationConfig, RecordData, SingleRecordResponse, UpdateRequest } from '@objectstack/spec/api';
import type { ApiError, BaseResponse, BatchLoadingStrategy, BulkRequest, BulkResponse, CreateRequest, DataLoaderConfig, DeleteResponse, ExportRequest, IdRequest, ListRecordResponse, ModificationResult, QueryOptimizationConfig, RecordData, SingleRecordResponse, UpdateRequest } from '@objectstack/spec/api';
// Validate data
const result = ApiError.parse(data);
| Property |
Type |
Required |
Description |
| code |
Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'> |
✅ |
Error code (e.g. VALIDATION_ERROR; StandardErrorCode ∪ ERROR_CODE_LEDGER) |
| message |
string |
✅ |
Readable error message |
| category |
string |
optional |
Error category (e.g. validation, authorization) |
| httpStatus |
integer |
optional |
HTTP status of the response carrying this error |
| details |
any |
optional |
Additional error context (e.g. field validation errors) |
| requestId |
string |
optional |
Request ID for tracking |
| Property |
Type |
Required |
Description |
| success |
boolean |
✅ |
Operation success status |
| error |
{ code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } |
optional |
Error details if success is false |
| meta |
{ timestamp: string; duration?: number; requestId?: string; traceId?: string } |
optional |
Response metadata |
| Property |
Type |
Required |
Description |
| strategy |
Enum<'dataloader' | 'windowed' | 'prefetch'> |
✅ |
Batch loading strategy type |
| windowMs |
number |
optional |
Collection window duration in milliseconds (for windowed strategy) |
| prefetchDepth |
integer |
optional |
Depth of relation prefetching (for prefetch strategy) |
| associationLoading |
Enum<'lazy' | 'eager' | 'batch'> |
✅ |
How to load related associations |
| Property |
Type |
Required |
Description |
| records |
Record<string, any>[] |
✅ |
Array of records to process |
| allOrNone |
boolean |
✅ |
If true, rollback entire transaction on any failure |
| Property |
Type |
Required |
Description |
| success |
boolean |
✅ |
Operation success status |
| error |
{ code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } |
optional |
Error details if success is false |
| meta |
{ timestamp: string; duration?: number; requestId?: string; traceId?: string } |
optional |
Response metadata |
| data |
{ id?: string; success: boolean; errors?: { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … }[]; index?: number; … }[] |
✅ |
Results for each item in the batch |
| Property |
Type |
Required |
Description |
| data |
Record<string, any> |
✅ |
Record data to insert |
| Property |
Type |
Required |
Description |
| maxBatchSize |
integer |
✅ |
Maximum number of keys per batch load |
| batchScheduleFn |
Enum<'microtask' | 'timeout' | 'manual'> |
✅ |
Scheduling strategy for collecting batch keys |
| cacheEnabled |
boolean |
✅ |
Enable per-request result caching |
| cacheKeyFn |
string |
optional |
Name or identifier of the cache key function |
| cacheTtl |
number |
optional |
Cache time-to-live in seconds (0 = no expiration) |
| coalesceRequests |
boolean |
✅ |
Deduplicate identical requests within a batch window |
| maxConcurrency |
integer |
optional |
Maximum parallel batch requests |
| Property |
Type |
Required |
Description |
| success |
boolean |
✅ |
Operation success status |
| error |
{ code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } |
optional |
Error details if success is false |
| meta |
{ timestamp: string; duration?: number; requestId?: string; traceId?: string } |
optional |
Response metadata |
| id |
string |
✅ |
ID of the deleted record |
| Property |
Type |
Required |
Description |
| object |
string |
✅ |
Object name (e.g. account) |
| fields |
string[] |
optional |
Fields to retrieve — field names, optionally dotted to reach through a relationship (owner.name). Related records are selected with expand, not from inside this list. |
| where |
any |
optional |
Filtering criteria (WHERE) |
| search |
string | { query: string; fields?: string[]; fuzzy: boolean; operator: Enum<'and' | 'or'>; … } |
optional |
Full-text search — the query text (canonical, ADR-0061 D1), or a structured FullTextSearch configuration |
| searchFields |
string[] |
optional |
Narrow the search to these fields (server-intersected with the allowed searchable set — can only narrow, never widen; ADR-0061 D1) |
| orderBy |
{ field: string; order: Enum<'asc' | 'desc'> }[] |
optional |
Sorting instructions (ORDER BY) |
| limit |
number |
optional |
Max records to return (LIMIT) |
| offset |
number |
optional |
Records to skip (OFFSET) |
| top |
number |
optional |
Alias for limit (OData compatibility) |
| cursor |
any |
optional |
[REMOVED] query.cursor was removed in @objectstack/spec 17 (#4286, ADR-0049) — no driver ever implemented keyset pagination, so the cursor was accepted and ignored and every page came back identical (a caller looping "until hasMore is false" never terminates). Delete the key; QueryBuilder.cursor() was removed with it. Express the keyset as an ordinary where predicate on your sort key — where: { created_at: { $gt: last.created_at } } with the matching orderBy — which every driver executes with canonicalised comparands. A first-class cursor, if ever built, will be a response-minted opaque token, not this caller-built record. |
| joins |
any |
optional |
[REMOVED] query.joins was removed in @objectstack/spec 17 (#4286, ADR-0049) — no engine or driver ever read it: a query carrying joins behaved exactly as if the key were absent, while its name squatted on the reserved REST parameter set. Delete the key. Related records are read through expand — expand: { owner: { object: 'user', fields: ['name'] } } — which the engine resolves via batch $in queries, and a single related column is a dotted fields path (fields: ['owner.name']). |
| aggregations |
{ function: Enum<'count' | 'sum' | 'avg' | 'min' | 'max' | 'count_distinct' | 'array_agg' | 'string_agg'>; field?: string; alias: string; distinct?: boolean; … }[] |
optional |
Aggregation functions |
| groupBy |
string | { field: string; dateGranularity?: Enum<'day' | 'week' | 'month' | 'quarter' | 'year'>; alias?: string }[] |
optional |
GROUP BY targets (strings or {field, dateGranularity?} objects for date bucketing) |
| having |
any |
optional |
HAVING — filter over the AGGREGATED rows (aggregation aliases + groupBy projections); applied engine-side after aggregation |
| windowFunctions |
any |
optional |
[REMOVED] query.windowFunctions was removed in @objectstack/spec 17 (#4286, ADR-0049) — find() never applied it: no engine or driver read the key on the query path, so every OVER clause it declared was silently dropped. Delete the key. Window functions are a SQL-driver capability behind SqlDriver.findWithWindowFunctions(object, query) (embedder-level; not on the IDataDriver contract or the REST surface); request-level analytics are aggregations + groupBy. |
| distinct |
any |
optional |
[REMOVED] query.distinct was removed in @objectstack/spec 17 (#4286, ADR-0049 / ADR-0078) — no driver ever rendered SELECT DISTINCT; the flag's only observable effect was MIS-WIRED: the REST list path treated a distinct query as not countable and silently degraded total/hasMore to a page-local estimate while still returning duplicate rows. Delete the key; QueryBuilder.distinct() was removed with it, and the count suppression is gone (total is truthful again). For unique values of one column use the SQL/memory drivers' distinct(object, field) door; for unique combinations, groupBy; for a deduplicated count, the count_distinct aggregation. |
| expand |
Record<string, { object: string; fields?: string[]; where?: any; search?: string | { query: string; fields?: string[]; fuzzy: boolean; operator: Enum<'and' | 'or'>; … }; … }> |
optional |
Recursive relation loading map. Keys are lookup/master_detail field names; values are nested QueryAST objects that control select (fields) and filter (where, AND-merged with the batch $in), plus further expansion on the related object. The engine resolves expand via batch $in queries (driver-agnostic) with a default max depth of 3; per-parent limit/offset/orderBy are NOT applied on this path. |
| Property |
Type |
Required |
Description |
| id |
string |
✅ |
Record ID |
| Property |
Type |
Required |
Description |
| success |
boolean |
✅ |
Operation success status |
| error |
{ code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } |
optional |
Error details if success is false |
| meta |
{ timestamp: string; duration?: number; requestId?: string; traceId?: string } |
optional |
Response metadata |
| data |
Record<string, any>[] |
✅ |
Array of matching records |
| pagination |
{ total?: number; limit?: number; offset?: number; cursor?: string; … } |
✅ |
Pagination info |
| Property |
Type |
Required |
Description |
| id |
string |
optional |
Record ID if processed |
| success |
boolean |
✅ |
|
| errors |
{ code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … }[] |
optional |
|
| index |
number |
optional |
Index in original request |
| data |
any |
optional |
Result data (e.g. created record) |
| Property |
Type |
Required |
Description |
| preventNPlusOne |
boolean |
✅ |
Enable N+1 query detection and prevention |
| dataLoader |
{ maxBatchSize: integer; batchScheduleFn: Enum<'microtask' | 'timeout' | 'manual'>; cacheEnabled: boolean; cacheKeyFn?: string; … } |
optional |
DataLoader batch loading configuration |
| batchStrategy |
{ strategy: Enum<'dataloader' | 'windowed' | 'prefetch'>; windowMs?: number; prefetchDepth?: integer; associationLoading: Enum<'lazy' | 'eager' | 'batch'> } |
optional |
Batch loading strategy configuration |
| maxQueryDepth |
integer |
✅ |
Maximum depth for nested relation queries |
| queryComplexityLimit |
number |
optional |
Maximum allowed query complexity score |
| enableQueryPlan |
boolean |
✅ |
Log query execution plans for debugging |
| Property |
Type |
Required |
Description |
| success |
boolean |
✅ |
Operation success status |
| error |
{ code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_DATASOURCE_ERROR' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } |
optional |
Error details if success is false |
| meta |
{ timestamp: string; duration?: number; requestId?: string; traceId?: string } |
optional |
Response metadata |
| data |
Record<string, any> |
✅ |
The requested or modified record |
| Property |
Type |
Required |
Description |
| data |
Record<string, any> |
✅ |
Partial record data to update |