Deprecated - API is expected to be removed within next one or two major version upgrade.
The deprecation notice/comment will say when the API will be removed and what alternatives should be used instead.
paths:
'/data-jobs/for-team/{team_name}/info':
get:
tags:
- Data Jobs Service
responses:
'200':
$ref: '#/components/responses/Info'
operationId: info
summary: Get API and Data Jobs Service info
description: (Introduced in v1.0) | Get API and Data Jobs service information
parameters:
- name: team_name
description: Team Name
schema:
type: string
in: path
required: true
'/data-jobs/for-team/{team_name}':
get:
deprecated: true
tags:
- Data Jobs
parameters:
- name: team_name
description: Team Name
schema:
type: string
in: path
required: true
- name: show_all
description: |
If set to 'true' will list the jobs for all the teams, otherwise will list only the jobs that belong to this team.
schema:
type: boolean
default: False
in: query
# This API supports pagination, because there can be thousands of data jobs.
# Page parameters are based on the offset and limit example at
# https://swagger.io/docs/specification/describing-parameters/#default adjusted for easier Spring use.
# We intentionally don't support consistent paging via cursors because it is quite resource-intensive -
# until explicitly requested.
- name: page_number
description: The number of pages of items to skip before starting to collect the result set.
schema:
type: integer
minimum: 0
default: 0
example: 0
required: false
in: query
- name: page_size
schema:
type: integer
minimum: 1
maximum: 100 # Over 100 items will make the resulting JSON too large to serialize safely.
default: 20
example: 0
required: false
description: The number of items per page
in: query
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DataJobSummary'
description: List of jobs
'400':
$ref: '#/components/responses/Error'
operationId: jobsList
summary: List all or Team's Data Jobs | (Stable)
description: (Introduced in v1.0)
'/data-jobs/for-team/{team_name}/jobs':
get:
operationId: jobsQuery
summary: List Data Jobs | (Experimental)
tags:
- Data Jobs
description: |
List data Jobs with GraphQL like query. By choosing which field to be returned you can control the output.
You can learn more about the GraphQL queries by visiting [GraphQL official website](https://graphql.org/learn/queries/)
Query should be provided as GET parameter, not by POST body. Don't worry about the spaces and tabs
Keep in mind that each aditional field could make query response time slower, for instance deployments,
it's best if you request only what you need
The pageNumber and pageSize arguments are required! Page number should be a number greater than 1,
and pageSize should be greater than 1 (per page)
Check the latest example for the full list of supported query fields.
Simplest query that you could make is to fetch the job names
{
jobs(pageNumber: 1, pageSize: 25) {
content {
jobName
}
}
}
You could also use filtering and sorting function. Filter object has property, pattern and sort fields.
* property points out which field you want to filter, if you point out some other field that is not supported,
an invalid response will be return.
* pattern should be a non-empty string which the provided property should contains [ignoring cases], for instance: `starshot` pattern will match
import-starshot-sql, StarShot-servers and notify-starshot job names, but it won't match stars-shot-daily-prune`
If a pattern string is not provided, then you must atleast provide the property field
* sort should be an enum value - ASC (ascending) or DESC (descending) option [not required, default is ASC]
Multiple filters could be applied, but maximum one should contain sorting!
{
jobs(
pageNumber: 1,
pageSize: 25,
filter: [{
property: "jobName",
pattern: "starshot",
sort: "DESC"
}],
) {
content {
jobName
}
}
}
You could also search for a string into the properties that you are requesting, for instance:
This query will search for job names, team names and descriptions which contains the provided "starshot" string
{
jobs(
pageNumber: 1,
pageSize: 25,
search: "starshot"
) {
content {
jobName,
config {
team
description
}
}
}
}
Full example of currently available for fetching fields. Note that if you combine searching and filtering, first
it will apply filters and then within filtered jobs it will apply the search, vice versa is currently not supported:
{
jobs(
pageNumber: 1,
pageSize: 25,
search: "daily",
filter: [{
property: "jobName",
pattern: "import-sql",
},{
property: "team",
pattern: "starshot",
sort: "DESC"
},{
property: "deployments.enabled",
pattern: "enabled",
}],
) {
content {
jobName
config {
team
description
sourceUrl
schedule {
scheduleCron
nextRunEpochSeconds
}
contacts {
notifiedOnJobFailureUserError
notifiedOnJobFailurePlatformError
notifiedOnJobSuccess
notifiedOnJobDeploy
}
}
deployments {
id
enabled
jobVersion
mode
}
}
totalPages
totalItems
}
}
}
parameters:
- name: team_name
description: The Team which owns the Data Job
schema:
type: string
in: path
required: true
- name: query
description: Request a GraphQL-like query.
schema:
type: string
example: |
{
jobs(pageNumber: 1, pageSize: 20, filter: []) {
content {
jobName
config {
team
description
schedule {
scheduleCron
nextRunEpochSeconds
}
sourceUrl
contacts {
notifiedOnJobFailureUserError
notifiedOnJobFailurePlatformError
notifiedOnJobSuccess
notifiedOnJobDeploy
}
}
}
totalPages
totalItems
}
}
default: |
{
jobs(pageNumber: 1, pageSize: 20, filter: []) {
content {
jobName
config {
team
description
schedule {
scheduleCron
}
}
}
totalPages
totalItems
}
}
required: false
in: query
- name: operation_name
description: If the query is specified and contains several named operations, an operation_name query parameter can be used to control which one should be executed
schema:
type: string
example: jobs
required: false
in: query
- name: variables
description: If query is specified then variables can be sent as a JSON-encoded string in an additional query parameter called variables
schema:
type: string
example: |
{
"pageSize": "10",
"pageNumber": "1"
}
required: false
in: query
responses:
'200':
$ref: '#/components/responses/DataJobQueryResponse'
'400':
$ref: '#/components/responses/DataJobQueryResponseWithError'
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataJob'
required: true
parameters:
- name: team_name
description: The Team which owns the Data Job
schema:
type: string
in: path
required: true
- in: query
name: name
schema:
type: string
required: false
description: The Name of the Data Job
tags:
- Data Jobs
responses:
'201':
description: Created successfully.
'400':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
operationId: dataJobCreate
summary: Creates a new Data Job | (Stable)
description: |
(Introduced in v1.0) | Creates a new Data Job.
The name of the Data job should comply to the following naming convention: