Alteryx · Schema
Alteryx Workflow
Schema for an Alteryx Server workflow resource as returned by the Alteryx Server API V3. Represents workflows uploaded to and managed on Alteryx Server, including version history, execution settings, and access permissions.
AnalyticsAutomationData EngineeringData PreparationData ScienceETLMachine LearningPredictive Analytics
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the workflow assigned by Alteryx Server. |
| sourceAppId | string | Source application identifier used for migration tracking between Server environments. |
| name | string | Display name of the workflow. |
| ownerId | string | Unique identifier of the user who owns the workflow. |
| dateCreated | string | ISO 8601 date and time when the workflow was first created on the server. |
| publishedVersionNumber | integer | Version number of the currently published version of the workflow. |
| publishedVersionId | string | Unique identifier of the currently published workflow version. |
| isAmp | boolean | Indicates whether the workflow uses the AMP (Alteryx Multi-threaded Processing) engine. |
| executionMode | string | Execution mode controlling which tools and operations are permitted. Safe mode restricts potentially dangerous operations, SemiSafe allows some, and Standard allows all. |
| runCount | integer | Total number of times the workflow has been executed. |
| workerTag | string | Worker tag used to route execution to specific worker nodes. |
| districtTags | array | District tags assigned to the workflow for organizational grouping. |
| comments | string | User-provided comments or notes about the workflow. |
| isPublic | boolean | Whether the workflow is publicly accessible to all Server users. |
| isReadyForMigration | boolean | Whether the workflow is flagged as ready for migration to another Server environment. |
| othersMayDownload | boolean | Whether users other than the owner may download the workflow package. |
| othersCanViewHistory | boolean | Whether users other than the owner can view execution history. |
| othersCanExecute | boolean | Whether users other than the owner can execute the workflow. |
| hasPrivateDataExemption | boolean | Whether the workflow has an exemption from private data restrictions. |
| workflowCredentialType | string | Specifies how credentials are handled for workflow execution. Default uses the system default, Required prompts the user, and Specific uses a designated credential. |
| credentialId | string | Identifier of the specific credential to use when workflowCredentialType is set to Specific. |
| versions | array | List of all versions of this workflow. |