Workflows

Patch a workflow definition (create/update/delete nodes)

Changed on
patch/api/workflows/{id}

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/workflows/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

deletestring[]

Node IDs to delete

onNodeFailure'fail' | 'continue'

Update the definition-level onNodeFailure behavior

triggerSchemaobject nullable

Optional JSON-Schema describing the expected trigger payload shape. Pass an object to set/replace; pass null to clear; omit to leave unchanged. Validator subset: type, required, properties, enum, const, items. Other JSON-Schema keywords are silently ignored.

paramsobject
requiredParamsstring[]
requiresstring[]
keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

Response

Workflow patched (version snapshot created)

idstring uuid required
keystring required

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

namestring required
descriptionstring
enabledboolean required
inputobject
triggerSchemaobject
paramsobject
requiredParamsstring[]
requiresstring[]
dirstring
vcsRepostring
createdByAgentIdstring
createdAtstring required
lastUpdatedAtstring required
createdBystring
updatedBystring
favoriteboolean
warningsstring[]

Changes

    • info

      added the optional property ///// to the response with the status

    • warning

      added the new azure-devops.work_item.assigned enum value to the /////// response property for the response status

    • warning

      added the new azure-devops.work_item.commented enum value to the /////// response property for the response status