Skip to main content

PublicWorkspaceViewModel

Detailed workspace representation including its contained analytic tasks.

namestringrequired

The unique name of the workspace.

Possible values: <= 30 characters

descriptionstringnullable

The description detailing the workspace purpose.

Possible values: <= 1000 characters

tagsstring[]nullable

The list of tags assigned to the workspace.

analyticTasks object[]nullable

The list of analytic tasks contained within the workspace.

  • Array [
  • idstring<uuid>

    The unique identifier of the task.

    namestringnullable

    The display name of the task.

    Possible values: <= 64 characters

    descriptionstringnullable

    The optional description detailing the task purpose.

    Possible values: <= 1000 characters

    strategyAuditTypeStrategy

    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]

    scheduleFrequencyScheduleFrequency

    Defines how often an analytic task is scheduled to run.

    Enum values:

    • Once: Runs exactly once at the scheduled start time or immediately.
    • Hourly: Runs at the configured interval of hours.
    • Daily: Runs at the configured interval of days.
    • Weekly: Runs on the configured days of the week.
    • Monthly: Runs on the configured days of the month and/or on the last day of the month.
    • Loop: Runs continuously in Real-Time loops with an optional Start Delay.

    Possible values: [Once, Hourly, Daily, Weekly, Monthly, Loop]

    lastAnalyticRunStatusAnalyticRunStatus

    Describes the current execution outcome of an analytic run.

    Enum values:

    • Running: The analytic run is currently executing.
    • Succeeded: The analytic run completed successfully.
    • Failed: The analytic run ended because execution failed.
    • Canceled: The analytic run was canceled before completion.

    Possible values: [Running, Succeeded, Failed, Canceled]

    workspaceIdstring<uuid>

    The unique identifier of the parent workspace.

    isActiveboolean

    Indicates whether the task is active and eligible for scheduled execution.

    analyticGroupNamestringnullable

    The resolved display name of the associated analytic group.

    dataStrategyNamestringnullable

    The resolved display name of the associated data strategy.

    sqlServerNamestringnullable

    The resolved display name of the associated SQL Server connection.

    fabricMirrorConnectionNamestringnullable

    The resolved display name of the associated Microsoft Fabric Mirror connection.

    snowflakeConnectionNamestringnullable

    The resolved display name of the associated Snowflake connection.

    fabricLakehouseConnectionNamestringnullable

    The resolved display name of the associated Microsoft Fabric Lakehouse connection.

    azureDataLakeConnectionNamestringnullable

    The resolved display name of the associated Azure Data Lake Storage connection.

    googleCloudStorageConnectionNamestringnullable

    The resolved display name of the associated Google Cloud Storage connection.

    connectionTypeConnectionType

    Identifies the destination connection type used by a task.

    Enum values:

    • FabricMirror: Uses a Microsoft Fabric Mirror connection.
    • FabricLakehouse: Uses a Microsoft Fabric Lakehouse connection.
    • Snowflake: Uses a Snowflake connection.
    • AzureDataLake: Uses an Azure Data Lake Storage connection.
    • Unknown: The destination connection type could not be resolved for this task.

    Possible values: [FabricMirror, FabricLakehouse, Snowflake, AzureDataLake, GoogleCloudStorage, Unknown]

  • ]
  • PublicWorkspaceViewModel
    {
    "name": "string",
    "description": "string",
    "tags": [
    "string"
    ],
    "analyticTasks": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "strategy": "Analyze",
    "scheduleFrequency": "Once",
    "lastAnalyticRunStatus": "Running",
    "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isActive": true,
    "analyticGroupName": "string",
    "dataStrategyName": "string",
    "sqlServerName": "string",
    "fabricMirrorConnectionName": "string",
    "snowflakeConnectionName": "string",
    "fabricLakehouseConnectionName": "string",
    "azureDataLakeConnectionName": "string",
    "googleCloudStorageConnectionName": "string",
    "connectionType": "FabricMirror"
    }
    ]
    }