/submitPersistJob

Submit a regular job

submit persist or incremental job

post

submit persist or incremental job

Query parameters

accountstringOptional

account name of the target database

passwordstringOptional

db password

portinteger · int32Optional

db port

databasestringOptional

source database

schedulablebooleanOptional

whether schedulable

Default: false

cronExpressionstringOptional

cron expression to schedule time for the job to be executed

Example: 0 1 * * *

dbvendorstringRequired

database dbvendor

defaultDatabasestringOptional

default databse when there's no metadata

defaultSchemastringOptional

default schema

extrastringOptional

extra

firstSubmitbooleanOptional

whether this is the first submit

Default: false

hostnamestringOptional

db hostname

incrementalbooleanOptional

whether incremental job

Default: true

jobIdstringOptional

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.

jobNamestringOptional

jobName

onTopbooleanOptional

whether set the job on the top

Default: false

sqlsourcestringOptional

sqlsource

tokenstringRequired

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

userIdstringRequired

userId

Body

sqlfilesstring · binary[]Optional

Responses

200

OK

application/json;charset=utf-8

ResponsestringExample: {"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"}}

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /api/gspLive_backend/sqlflow/job/submitPersistJob HTTP/1.1
Host: api.gudusoft.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 23

{
  "sqlfiles": [
    "binary"
  ]
}

{
  "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"
  }
}

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!