Update a Workflow Approval Template
patch
/api/v2/workflow_approval_templates/{id}/
Make a PUT or PATCH request to this resource to update this workflow approval template. The following fields may be modified:
name
: Name of this workflow approval template. (string, required)-
description
: Optional description of this workflow approval template. (string, default=""
) -
execution_environment
: The container image to be used for execution. (id, default=``) timeout
: The amount of time (in seconds) before the approval node expires and fails. (integer, default=0
)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : WorkflowApprovalTemplate
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
execution_environment:
integer
Title:
Execution environment
The container image to be used for execution. -
id:
integer
Title:
ID
Read Only:true
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
Read Only:true
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
- related: string
-
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
timeout:
integer
Title:
Timeout
The amount of time (in seconds) before the approval node expires and fails. -
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Response
Supported Media Types
- application/json
200 Response
Root Schema : WorkflowApprovalTemplate
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
execution_environment:
integer
Title:
Execution environment
The container image to be used for execution. -
id:
integer
Title:
ID
Read Only:true
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
Read Only:true
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
- related: string
-
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
timeout:
integer
Title:
Timeout
The amount of time (in seconds) before the approval node expires and fails. -
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true