/submitPersistJob

Submit a regular job

submit persist or incremental job

submit persist or incremental job

post

/sqlflow/job/submitPersistJob

Query parameters

accountstring

account name of the target database

passwordstring

db password

portinteger · int32

db port

databasestring

source database

schedulableboolean

whether schedulable

cronExpressionstring

cron expression to schedule time for the job to be executed

Example: 0 1 * * *

dbvendorstringrequired

database dbvendor

defaultDatabasestring

default databse when there's no metadata

defaultSchemastring

default schema

extrastring

extra

firstSubmitboolean

whether this is the first submit

hostnamestring

db hostname

incrementalboolean · default: true

whether incremental job

jobIdstring

jobId should be null for the first submit and please note down the jobId field from response message. jobId cannot be null for next submit. Give the jobId which is returned in the first submit response.

jobNamestring

jobName

onTopboolean

whether set the job on the top

sqlsourcestring

sqlsource

tokenstringrequired

The token is generated from userid and usersecret. It is used in every Api invocation.

userIdstringrequired

userId

Body

sqlfilesstring · binary[]

Responses

application/json;charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gudusoft.com/api/gspLive_backend/sqlflow/job/submitPersistJob?dbvendor=text&token=text&userId=text' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"sqlfiles":[null]}'

200

201

401

403

404

200

{
  "code": 200,
  "data": {
    "jobId": "c359aef4bd9641d697732422debd8055",
    "jobName": "job1",
    "userId": "google-oauth2|104002923119102769706",
    "dbVendor": "dbvmssql",
    "createTime": "2020-12-15 15:14:39",
    "status": "create",
    "fileNames": [
      "1.sql",
      "1.zip"
    ],
    "dataSource": {}
  }
}

OK

Sample response:

{
	"code":200,
	"data":{
		"jobId":"c359aef4bd9641d697732422debd8055",
		"jobName":"job1",
		"userId":"google-oauth2|104002923119102769706",
		"dbVendor":"dbvmssql",
		"dataSource":{
			
		},
		"fileNames":["1.sql","1.zip"],
		"createTime":"2020-12-15 15:14:39",
		"status":"create"
	}
}

Try it out!