updateWorkflow

Update an existing workflow policy including pipeline application selection.

Examples

GraphQL

mutation UpdateWorkflow($input: UpdateWorkflowPolicyInput!) {
  updateWorkflow(input: $input) {
    id
    isValid
    createdAt
    createdBy
    enabled
    updatedAt
    updatedBy
    name
    description
    actions {
      name
      type
    }
    triggers {
      name
      category
    }
    runs
    lastRunTime
    workflowType
    isDefault
    monitorAllNewlyCreatedRepositories
    wfPipelineSettings {
      apps {
        appName
        appType
        appId
        selected
        disabled
      }
    }
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "input": {
    "id": "example",
    "name": "SomeName",
    "description": "example",
    "enabled": true,
    "pipelineSettings": {
      "apps": [
        {
          "appId": "30966426",
          "appName": "some-repo",
          "appType": "example",
          "selected": true,
          "disabled": true
        }
      ]
    },
    "isDefault": true,
    "monitorAllNewlyCreatedRepositories": 13.37,
    "monitorRepositories": "AddAll"
  }
}

cURL

Node.js

Python

Arguments

You can use the following argument(s) to customize your updateWorkflow mutation.

Argument	Description	Supported fields
input UpdateWorkflowPolicyInput! required	Workflow fields to update	id String! name String description String enabled Boolean pipelineSettings PipelineSettingsInput isDefault Boolean monitorAllNewlyCreatedRepositories Float monitorRepositories MonitorRepositories

Fields

Return type: WorkflowPolicy!

You can use the following field(s) to specify what information your updateWorkflow mutation will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
id String!	ID of the policy workflow
isValid Boolean	defines if workflow is valid or not
createdAt Float!	Time the workflow was created
createdBy String	Workflow creator
enabled Boolean	Enabled for evaluation
updatedAt Float!	Time the workflow was updated
updatedBy String	Workflow last updated by
name String!	Name of the workflow
description String	Description of the workflow
actions [Action!]!		name String type String
triggers [Trigger!]!		name String category String
runs Int	numbers of runs this workflow had
lastRunTime Float	last time this workflow had run
workflowType WorkflowType!	type of the workflow (Regular scan / Pipeline scan)
isDefault Boolean!	If the workflow is a default one
monitorAllNewlyCreatedRepositories Float	If this workflow should trigger for all newly created repos starting from the time it is set
wfPipelineSettings WfPipelineSettings	settings for pipeline	apps [WfApp!]