Skip to main content
POST
Create ScheduledJobExecution

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/json

A scheduled job execution records a single run of a scheduled job.

changeSequence
integer<int32>
completionMessage
string
createdOn
string<date-time>
endTime
string<date-time> | null
exceptionDetails
string
executionStatus
enum<string>
Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
NO_ACTION
id
string
logGroup
string
logStream
string
requestId
string
scheduledJob
object | null

A scheduled job automates document processing on a recurring basis.

scheduledJobId
string | null
startTime
string<date-time> | null
updatedOn
string<date-time>
userCancelled
boolean | null
uuid
string

Response

Created ScheduledJobExecution

A scheduled job execution records a single run of a scheduled job.

changeSequence
integer<int32>
completionMessage
string
createdOn
string<date-time>
endTime
string<date-time> | null
exceptionDetails
string
executionStatus
enum<string>
Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
NO_ACTION
id
string
logGroup
string
logStream
string
requestId
string
scheduledJob
object | null

A scheduled job automates document processing on a recurring basis.

scheduledJobId
string | null
startTime
string<date-time> | null
updatedOn
string<date-time>
userCancelled
boolean | null
uuid
string