Create a new Quickstart Transformation

Creates a new Quickstart transformation for the specified Quickstart model.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

paused

booleanrequired

The field indicates whether the Quickstart Transformation is in paused state.

model_id

stringrequired

The unique identifier for the Quickstart Model within the Fivetran system.

example:

model_id

run_tests

booleanrequired

The field indicates whether the tests have been configured for the Quickstart Transformation.

example:

true

Http + 1.1

POST

https://api.fivetran.com/v1/qdm/transformations

POST /v1/qdm/transformations HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 68

{
  "paused": false,
  "model_id": "model_id",
  "run_tests": true
}

Responses

201

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier for the Quickstart Transformation within the Fivetran system. Quickstart Transformation ids match with the Quickstart Model ids.

example:

transformation_id

name

stringrequired

The Quickstart Transformation name.

example:

transformation_name

status

stringrequired

The status of Quickstart Transformation.

enum:

"SUCCEEDED""RUNNING""FAILED""PENDING"

paused

booleanrequired

The field indicates whether the Quickstart Transformation is in paused state.

last_run

string

The last transformations run time.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

edited_by_id

string

The unique identifier of the User within the Fivetran system who last updated the Quickstart Transformation.

example:

user_id

package_id

stringrequired

The unique identifier for the Quickstart Package within the Fivetran system.

example:

package_id

selected_by_id

string

The unique identifier of the User within the Fivetran system who last selected or unselected the Quickstart Transformation.

example:

user_id

next_run

string

The nearest predicted time when this model can start again.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

run_tests

booleanrequired

The field indicates whether the tests have been configured for the Quickstart Transformation.

example:

true

edited_at

string

The last time when the Quickstart Transformation has been edited.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

selected_at

string

The last time when the Quickstart Transformation selected state has been changed.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "id": "transformation_id",
    "name": "transformation_name",
    "status": "SUCCEEDED",
    "paused": false,
    "last_run": "2023-08-20T10:15:20.677566Z",
    "edited_by_id": "user_id",
    "package_id": "package_id",
    "selected_by_id": "user_id",
    "next_run": "2023-08-20T10:15:20.677566Z",
    "run_tests": true,
    "edited_at": "2023-08-20T10:15:20.677566Z",
    "selected_at": "2023-08-20T10:15:20.677566Z"
  }
}