PublicAbstractTaskViewModel
Base configuration model for defining an analytic, extraction, or replication task.
The display name of the task.
Possible values: >= 3 characters and <= 64 characters
An optional description explaining the task purpose.
Possible values: <= 1000 characters
Defines whether a task analyzes data, extracts data, or replicates source tables.
Enum values:
Analyze: Analytic Tasks extract data, then run analytics on the extracted data.Extract: Extraction Tasks extract data to SQL Server.Replication: Replication Tasks replicate data to Cloud Connection targets.
Possible values: [Analyze, Extract, Replication]
analyticParameters object[]nullable
The static filter parameter values assigned to the task.
- object
- object
The unique identifier of the parameter receiving this filter value.
The literal filter value used when the parameter is not a range.
The lower bound used for a range filter.
The upper bound used for a range filter.
Defines the scope level at which a parameter applies.
Enum values:
Global: Applies across all extraction packages and data sources in the task.Variant: Applies specifically to an Initial or Delta package variant.SapConnection: Applies specifically to a single assigned SAP system connection.
Possible values: [Global, Variant, SapConnection]
Defines whether an extraction package runs in Initial baseline or Delta incremental mode.
Enum values:
Initial: Captures the full baseline data during an initial extraction.Delta: Captures only changes since the previous run during an incremental extraction.
Possible values: [Initial, Delta]
The ID of the SAP system connection to which this filter applies when it is limited to one system.
scheduledAnalyticParameters object[]nullable
The dynamic date-offset parameters evaluated when the task runs.
The unique identifier of the parameter evaluated at run time.
Defines the scope level at which a parameter applies.
Enum values:
Global: Applies across all extraction packages and data sources in the task.Variant: Applies specifically to an Initial or Delta package variant.SapConnection: Applies specifically to a single assigned SAP system connection.
Possible values: [Global, Variant, SapConnection]
Defines whether an extraction package runs in Initial baseline or Delta incremental mode.
Enum values:
Initial: Captures the full baseline data during an initial extraction.Delta: Captures only changes since the previous run during an incremental extraction.
Possible values: [Initial, Delta]
The ID of the SAP system connection to which this filter applies when it is limited to one system.
scheduledFiscalYearParameters object[]nullable
The fiscal year parameters evaluated when the task runs.
The unique identifier of the parameter evaluated at run time.
Defines the scope level at which a parameter applies.
Enum values:
Global: Applies across all extraction packages and data sources in the task.Variant: Applies specifically to an Initial or Delta package variant.SapConnection: Applies specifically to a single assigned SAP system connection.
Possible values: [Global, Variant, SapConnection]
Defines whether an extraction package runs in Initial baseline or Delta incremental mode.
Enum values:
Initial: Captures the full baseline data during an initial extraction.Delta: Captures only changes since the previous run during an incremental extraction.
Possible values: [Initial, Delta]
The ID of the SAP system connection to which this filter applies when it is limited to one system.
The analytic group that defines the algorithms for an Analytic Task.
The unique identifier of the parent workspace containing the task.
The data strategy governing data retention and merge behavior for non-Replication tasks.
The ID of the Microsoft Fabric Mirror destination connection for a Replication Task.
The ID of the Snowflake destination connection for a Replication Task.
The ID of the Azure Data Lake Storage destination connection for a Replication Task.
The ID of the Google Cloud Storage destination connection for a Replication Task.
The ID of the Microsoft Fabric Lakehouse destination connection for a Replication Task.
The name of the destination SQL database used by the task.
Possible values: <= 128 characters
Defines the recurrence interval for task execution.
Enum values:
Once: Executes exactly once at the scheduled start time or immediately.Hourly: Executes periodically every configured number of hours.Daily: Executes periodically every configured number of days.Weekly: Executes periodically on selected days of the week.Monthly: Executes periodically on selected days of the month and/or on the last day of the month.RealTime: Executes continuously in Real-Time loops with an optional Start Delay.
Possible values: [Once, Hourly, Daily, Weekly, Monthly, RealTime]
The positive number of hours, days, or months between executions for Hourly, Daily, or Monthly schedules. Hourly values are 1–23, Daily values are 1–6, and Monthly values are 1–12.
The optional Start Delay in minutes between Real-Time execution loops (1–59).
The local scheduled start date and time in ISO 8601 format (for example, 2026-10-19T09:30:00), interpreted in the specified time zone. When provided, the public API rounds this value up to the next 15-minute boundary; values already on a boundary are unchanged.
The IANA time zone identifier used to interpret the scheduled start time (for example, Europe/Berlin).
Indicates whether the task is deactivated and excluded from scheduled execution.
Indicates whether extracted field names are prefixed with their source names.
Indicates whether existing primary key values are overwritten during data processing.
Defines which ends of extracted SAP string values have whitespace trimmed.
Enum values:
Both: Trims whitespace from both the start and end of SAP string values.Start: Trims whitespace from the start of SAP string values.End: Trims whitespace from the end of SAP string values.None: Preserves whitespace at both ends of SAP string values.
Possible values: [Both, Start, End, None]
Defines how sensitive values are protected in task data.
Enum values:
None: Leaves sensitive values unchanged.Pseudonymize: Replaces sensitive values with pseudonyms while preserving their linkable identity.Anonymize: Removes identifying information so the original identities cannot be recovered from the data.
Possible values: [None, Pseudonymize, Anonymize]
The salt used for hash-based pseudonymization; other privacy protection methods do not use it.
The destination schema used to store extracted or replicated source tables (required when replicating to Snowflake or Microsoft Fabric Mirror).
Possible values: <= 128 characters
The extracted data schema used to store raw source tables (prefer extractedDataSchema when creating tasks).
Possible values: <= 128 characters
The destination schema used to store processed calculation results and views (required for Analyze tasks).
Possible values: <= 128 characters
Defines how replicated data is applied to existing destination tables.
Enum values:
Merge: Merges replicated rows into the existing destination tables.Overwrite: Overwrites existing destination table contents with replicated data.
Possible values: [Merge, Overwrite]
Indicates whether the task uses separate Initial and Delta package variants.
The unique identifiers of parameter tables assigned to the task.
The selected weekdays (0 for Sunday through 6 for Saturday) for Weekly schedules or calendar days (1 through 28) for Monthly schedules, with -1 denoting the last day of the month.
{
"name": "string",
"description": "string",
"strategy": "Analyze",
"analyticParameters": [
{
"parameterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"value": "string",
"fromValue": "string",
"toValue": "string",
"parameterScope": "Global",
"variantType": "Initial",
"sapCredentialsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
{
"parameterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"value": "string",
"fromValue": "string",
"toValue": "string",
"parameterScope": "Global",
"variantType": "Initial",
"sapCredentialsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"scheduledAnalyticParameters": [
{
"target": "Value",
"referenceDate": "StartDate",
"offsetValue": 0,
"offsetUnit": "Day"
}
],
"scheduledFiscalYearParameters": [
{
"calendarYearEqualsFiscalYear": true,
"customDateStart": "2024-07-29T15:51:28.071Z",
"customDateEnd": "2024-07-29T15:51:28.071Z",
"customFiscalYear": 0,
"referenceFilterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"analyticGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dataStrategyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fabricMirrorConnectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"snowflakeConnectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"azureDataLakeConnectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"googleCloudStorageConnectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fabricLakehouseConnectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sqlDatabaseName": "string",
"scheduleFrequency": "Once",
"runEvery": 0,
"realTimeDelayInMinutes": 0,
"startTime": "2024-07-29T15:51:28.071Z",
"timeZoneId": "string",
"isDeactivated": true,
"prefixFieldNames": true,
"primaryKeyOverwrite": true,
"stringTrimmingStrategy": "Both",
"privacyProtection": "None",
"privacyProtectionSalt": "string",
"extractedDataSchema": "string",
"downloadSchema": "string",
"processedDataSchema": "string",
"replicationDataStrategy": "Merge",
"useInitialAndDelta": true,
"parameterTableIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scheduleDays": [
0
]
}