---
title: "PATCH /v1/{+name}"
method: PATCH
path: "/v1/{+name}"
tags: ["projects"]
---

# PATCH /v1/{+name}

`PATCH /v1/{+name}`

Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*

## Path parameters

- `name` string, required

## Query parameters

- `updateMask` string

## Request body

- WorkflowConfig — Represents a Dataform workflow configuration.
  - `releaseConfig` string — Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
  - `createTime` string, google-datetime — Output only. The timestamp of when the WorkflowConfig was created.
  - `invocationConfig` InvocationConfig — Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included.
    - `serviceAccount` string — Optional. The service account to run workflow invocations under.
    - `queryPriority` 'QUERY_PRIORITY_UNSPECIFIED' | 'INTERACTIVE' | 'BATCH' — Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.
    - `includedTags` string[] — Optional. The set of tags to include.
    - `transitiveDependenciesIncluded` boolean — Optional. When set to true, transitive dependencies of included actions will be executed.
    - `transitiveDependentsIncluded` boolean — Optional. When set to true, transitive dependents of included actions will be executed.
    - `fullyRefreshIncrementalTablesEnabled` boolean — Optional. When set to true, any incremental tables will be fully refreshed.
    - `includedTargets` Target[] — Optional. The set of action identifiers to include.
      - `name` string — Optional. The action's name, within `database` and `schema`.
      - `schema` string — Optional. The action's schema (BigQuery dataset ID), within `database`.
      - `database` string — Optional. The action's database (Google Cloud project ID) .
  - `disabled` boolean — Optional. Disables automatic creation of workflow invocations.
  - `name` string — Identifier. The workflow config's name.
  - `timeZone` string — Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
  - `internalMetadata` string — Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
  - `recentScheduledExecutionRecords` ScheduledExecutionRecord[] — Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
    - `workflowInvocation` string — The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
    - `executionTime` string, google-datetime — Output only. The timestamp of this execution attempt.
    - `errorStatus` Status — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      - `code` integer — The status code, which should be an enum value of google.rpc.Code.
      - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use.
  - `updateTime` string, google-datetime — Output only. The timestamp of when the WorkflowConfig was last updated.
  - `cronSchedule` string — Optional. Optional schedule (in cron format) for automatic execution of this workflow config.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/dataform.md) · [All operations](https://skmtc.net/google/apis/dataform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dataform/versions/b9dafc69d5c5/schema)