Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#76120)

github-automation-metabase366f27d2f01c
diff --git a/docs/api.json b/docs/api.json
index 33f431ab587..48af3662517 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -45750,7 +45750,15 @@
"type" : "null"
} ]
},
- "start_time" : { }
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
@@ -46095,7 +46103,15 @@
"type" : "null"
} ]
},
- "start_time" : { }
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
@@ -47222,6 +47238,321 @@
"tags" : [ "/api/transform-job" ]
}
},
+ "/api/transform-job/{job-id}/runs" : {
+ "get" : {
+ "operationId" : "get-api-transform-job-job-id-runs",
+ "summary" : "GET /api/transform-job/{job-id}/runs",
+ "description" : "Get paginated run history for a transform job.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "job-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "status",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "run-method",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "manual", "cron" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "start-time",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-column",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "start_time", "end_time" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-direction",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "updated_at" : { },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout" ]
+ },
+ "job_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "start_time" : { }
+ },
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "additionalProperties" : false
+ }
+ },
+ "limit" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "offset" : {
+ "type" : "integer"
+ },
+ "total" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "limit", "offset", "total" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/transform-job" ]
+ }
+ },
+ "/api/transform-job/{job-id}/runs/{run-id}/transform-runs" : {
+ "get" : {
+ "operationId" : "get-api-transform-job-job-id-runs-run-id-transform-runs",
+ "summary" : "GET /api/transform-job/{job-id}/runs/{run-id}/transform-runs",
+ "description" : "Get the transform runs that made up a specific job run.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "job-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "run-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_hi_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "transform" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "checkpoint_lo_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "checkpoint_filter_field_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "job_run_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/transform-job" ]
+ }
+ },
"/api/transform-job/{job-id}/transforms" : {
"get" : {
"operationId" : "get-api-transform-job-job-id-transforms",
@@ -47899,7 +48230,15 @@
"type" : "null"
} ]
},
- "start_time" : { }
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
@@ -48087,7 +48426,15 @@
"type" : "null"
} ]
},
- "start_time" : { }
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
@@ -48277,7 +48624,15 @@
"type" : "null"
} ]
},
- "start_time" : { }
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
@@ -48630,7 +48985,15 @@
"type" : "null"
} ]
},
- "start_time" : { }
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false
@@ -49120,7 +49483,15 @@
"type" : "null"
} ]
},
- "start_time" : { }
+ "start_time" : { },
+ "job_run_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
},
"required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
"additionalProperties" : false