Alteryx · Schema

UpdateWorkflowContract

Contract for updating an existing workflow

AnalyticsAutomationData EngineeringData PreparationData ScienceETLMachine LearningPredictive Analytics

Properties

Name Type Description
name string Updated workflow name
versionId string Version ID to update
makePublished boolean Whether to make the specified version published
ownerId string Updated owner ID
workerTag string Updated worker tag
districtTags array Updated district tags
comments string Updated comments
isPublic boolean
isReadyForMigration boolean
othersMayDownload boolean
othersCanExecute boolean
executionMode string
hasPrivateDataExemption boolean
workflowCredentialType string
credentialId string
View JSON Schema on GitHub

JSON Schema

alteryx-server-v3-update-workflow-contract-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UpdateWorkflowContract",
  "type": "object",
  "description": "Contract for updating an existing workflow",
  "properties": {
    "name": {
      "type": "string",
      "description": "Updated workflow name"
    },
    "versionId": {
      "type": "string",
      "description": "Version ID to update"
    },
    "makePublished": {
      "type": "boolean",
      "description": "Whether to make the specified version published"
    },
    "ownerId": {
      "type": "string",
      "description": "Updated owner ID"
    },
    "workerTag": {
      "type": "string",
      "description": "Updated worker tag"
    },
    "districtTags": {
      "type": "array",
      "description": "Updated district tags"
    },
    "comments": {
      "type": "string",
      "description": "Updated comments"
    },
    "isPublic": {
      "type": "boolean"
    },
    "isReadyForMigration": {
      "type": "boolean"
    },
    "othersMayDownload": {
      "type": "boolean"
    },
    "othersCanExecute": {
      "type": "boolean"
    },
    "executionMode": {
      "type": "string"
    },
    "hasPrivateDataExemption": {
      "type": "boolean"
    },
    "workflowCredentialType": {
      "type": "string"
    },
    "credentialId": {
      "type": "string"
    }
  }
}