...
POST /startScriptJob
Query parameters
auth - API key associated with the partner
userId - partner defined user id
Source Data: One is required
file - Identifier of designated file in backend system
fileUrl - URl to the file to open. Read only access (optional to the file parameter)
server - API server (not required if your files are loaded from S3 content bucket)File Source:
sessionId - Session id (optional, will be passed in header of requests to the API server)
token - Token (optional, will be passed in header of requests to the API server)
API Server
server - API server (not required if your files are loaded from S3 content bucket)
Partner Authentication (hosted version only)
auth - API key associated with the partner
userId - partner defined user id
Scripts
script - Url of the script file.
scriptOutputFile - It specifies the filename where the script output is written to. The file is uploaded to partner S3 content bucket logs folder. (optional)
Response
Text: JobID::{jobId}
...
auth - API key associated with the partner (hosted version only)
Response
Text: Job Status::{status}
...
If the parameter was not passed, a default output file named {file}.txt will be created.
Considerations for self hosted version
wt_config.xml for job storage table (dynamodb assumed). Set to empty for local storage and disable aws access.
| Code Block |
|---|
<property name="scriptDb"></property>
<property name="aws-access">false</property> |