Update a job

PATCH

/api/v1/jobs/{job_id}

curl --request PATCH \
  --url https://example.com/api/v1/jobs/1 \
  --header 'Content-Type: application/json' \
  --data '{ "new_settings": {}, "fields_to_remove": [ "example" ] }'

Update job settings with option to remove specific fields.

Parameters

Path Parameters

job_id

required

Job Id

integer

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

JobUpdateRequest

Request model for updating job settings.

object

new_settings

Any of:

object

object

key

additional properties

any

null

null

fields_to_remove

Any of:

Array<string>

Array<string>

null

null

Example^generated

{
  "new_settings": {},
  "fields_to_remove": [
    "example"
  ]
}

Responses

200

Successful Response

Media typeapplication/json

JobResponse

Response model for job information (flattened).

object

job_name

required

Job Name

Name of the job

string

job_type

Any of:

string

string

null

null

job_id

required

Job Id

integer

creator_user_name

Any of:

string

string

null

null

run_as_user_name

Any of:

string

string

null

null

created_time

Any of:

string

string format: date-time

null

null

modified_time

Any of:

string

string format: date-time

null

null

is_active

Is Active

boolean

default: true

tags

Any of:

object

object

key

additional properties

string

null

null

timeout_seconds

Any of:

integer

integer

null

null

max_concurrent_runs

Any of:

integer

integer

null

null

description

Any of:

string

string

null

null

settings

Any of:

object

object

key

additional properties

any

null

null

schedule_type

Any of:

string

string

null

null

schedule_details

Any of:

object

object

key

additional properties

any

null

null

continuous_config

Any of:

object

object

key

additional properties

any

null

null

notification_settings

Any of:

object

object

key

additional properties

any

null

null

health_rules

Any of:

object

object

key

additional properties

any

null

null

trigger_state

Any of:

object

object

key

additional properties

any

null

null

budget_policy_id

Any of:

string

string

null

null

usage_policy_id

Any of:

string

string

null

null

Example

{
  "is_active": true
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}