Skip to main content
Get Job Architecture Change Details

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

change_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Query Parameters

include
enum<string>[]

Additional data to include in the response. Use 'context' to include context information for the change.

Available options:
context

Response

OK

external_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

change_type
enum<string>
required

Type of change made to a Job.

Available options:
add_job_description
Example:

"add_job_description"

change_status
enum<string>
required

Current status of a Job change.

Available options:
preview,
generating,
generating_preview,
suggested,
saving,
saved,
deleted,
generate_failed,
save_failed
Example:

"suggested"

change_data
object
required

The actual change data

Example:
context
object

Context information for the change (included when include=context parameter is used)