workflow scheduler API 0.7

Overview

Api endpoints for exposing data models

Contact information

License information

License: Apache License Version 2.0 License URL: http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host: workflow-scheduler.branch-v07-nokrb.gotapaas.eu BasePath: /

Tags

workflow-scheduler-controller: Workflow Scheduler Controller

Paths

Get workflow scheduler configuration

GET /rest/v1/oozie/configuration

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	org	org	true	string

Responses

HTTP Code	Description	Schema
200	OK	WorkflowSchedulerConfigurationEntity

Consumes

application/json

Produces

application/json

Tags

workflow-scheduler-controller

Get list of coordinated jobs

GET /rest/v1/oozie/jobs/coordinated

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema
QueryParameter	org	org	true	string
QueryParameter	unit	unit	false	ref
QueryParameter	amount	amount	false	ref

Responses

HTTP Code	Description	Schema
200	OK	OozieCoordinatedJobInformation array

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Get details of specified coordinator job

GET /rest/v1/oozie/jobs/coordinated/{jobId}

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	jobId	jobId	true	string

Responses

HTTP Code	Description	Schema
200	OK	OozieCoordinatedJobInformation

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Get workflow jobs submitted by specified coordinator job

GET /rest/v1/oozie/jobs/coordinated/{jobId}/submitted

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema
PathParameter	jobId	jobId	true	string
QueryParameter	page	page	false	ref
QueryParameter	len	len	false	ref

Responses

HTTP Code	Description	Schema
200	OK	OozieWorkflowJobInformationExtended array

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Get list of workflow jobs

GET /rest/v1/oozie/jobs/workflow

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema
QueryParameter	org	org	true	string
QueryParameter	unit	unit	false	ref
QueryParameter	amount	amount	false	ref

Responses

HTTP Code	Description	Schema
200	OK	OozieWorkflowJobInformationExtended array

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Get details of specified workflow job

GET /rest/v1/oozie/jobs/workflow/{jobId}

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	jobId	jobId	true	string

Responses

HTTP Code	Description	Schema
200	OK	OozieWorkflowJobInformationExtended

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Get graph of specified job

GET /rest/v1/oozie/jobs/{jobId}/graph

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	jobId	jobId	true	string

Responses

HTTP Code	Description	Schema
200	OK	string array

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Get logs of specified job

GET /rest/v1/oozie/jobs/{jobId}/logs

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	jobId	jobId	true	string

Responses

HTTP Code	Description	Schema
200	OK	OozieJobLogs

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Submit action for specified job

PUT /rest/v1/oozie/jobs/{jobId}/manage

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	jobId	jobId	true	string
QueryParameter	action	action	true	string

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Schedule coordinated job

POST /rest/v1/oozie/schedule_job/coordinated

Description

Privilege level: Consumer of this endpoint must be a member of specified organization

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	org	org	false	ref
BodyParameter	sqoopScheduledImportJob	sqoopScheduledImportJob	true	SqoopScheduledImportJob

Responses

HTTP Code	Description	Schema
200	OK	OozieJobId

Consumes

application/json

Produces

/

Tags

workflow-scheduler-controller

Definitions

Collection«JDBCDriver»

Name	Description	Required	Schema	Default
empty		false	boolean

Database

Name	Description	Required	Schema	Default
drivers		false	Collection«JDBCDriver»
name		false	string

JDBCDriver

Name	Required	Schema
className	false	string
name	false	string
version	false	string

OozieCoordinatedJobAction

Name	Required	Schema
actionNumber	false	integer (int32)
consoleUrl	false	string
coordJobId	false	string
createdConf	false	string
createdTime	false	string
errorCode	false	string
errorMessage	false	string
externalId	false	string
externalStatus	false	string
id	false	string
lastModifiedTime	false	string
missingDependencies	false	string
nominalTime	false	string
pushMissingDependencies	false	string
runConf	false	string
status	false	string
toString	false	string
trackerUri	false	string
type	false	string

OozieCoordinatedJobInformation

Name	Required	Schema
acl	false	string
actions	false	OozieCoordinatedJobAction array
bundleId	false	string
concurrency	false	integer (int32)
conf	false	string
consoleUrl	false	string
coordExternalId	false	string
coordJobId	false	string
coordJobName	false	string
coordJobPath	false	string
endTime	false	string
executionPolicy	false	string
frequency	false	string
group	false	string
lastAction	false	string
matThrottling	false	integer (int32)
nextMaterializedTime	false	string
pauseTime	false	string
startTime	false	string
status	false	string
timeOut	false	integer (int32)
timeUnit	false	string
timeZone	false	string
toString	false	string
total	false	integer (int32)
user	false	string

OozieFrequency

Name	Description	Required	Schema	Default
amount		false	integer (int64)
unit		false	string

OozieJobId

Name	Description	Required	Schema	Default
id		false	string

OozieJobLogs

Name	Description	Required	Schema	Default
logs		false	string

OozieSchedule

Name	Required	Schema
endTimeUtc	false	LocalDateTime
frequency	false	OozieFrequency
start	true	LocalDateTime
startTimeUtc	false	LocalDateTime
zone	false	ZoneId
end	true	LocalDateTime
zoneId	true	ZoneId

OozieWorkflowJobAction

Name	Required	Schema
conf	false	string
consoleUrl	false	string
cred	false	string
data	false	string
endTime	false	string
errorCode	false	string
errorMessage	false	string
externalChildIDs	false	string
externalId	false	string
externalStatus	false	string
id	false	string
name	false	string
retries	false	integer (int32)
startTime	false	string
stats	false	string
status	false	string
toString	false	string
trackerUri	false	string
transition	false	string
type	false	string
userRetryCount	false	integer (int32)
userRetryInterval	false	integer (int32)
userRetryMax	false	integer (int32)

OozieWorkflowJobInformationExtended

Name	Required	Schema
acl	false	string
actions	false	OozieWorkflowJobAction array
appName	false	string
appPath	false	string
conf	false	string
consoleUrl	false	string
coordinatorId	false	string
createdTime	false	string
endTime	false	string
externalId	false	string
group	false	string
id	false	string
lastModTime	false	string
parentId	false	string
run	false	integer (int32)
startTime	false	string
status	false	string
targetDirs	false	string array
toString	false	string
user	false	string

SqoopImport

Name	Required	Schema
append	false	boolean
checkColumn	false	string
columns	false	string array
compress	false	boolean
driver	false	string
importMode	false	string
incremental	false	boolean
jdbcUri	false	string
lastValue	false	string
mappers	false	integer (int32)
nullNonString	false	string
nullString	false	string
overwrite	false	boolean
password	false	string
schema	false	string
table	false	string
targetDir	false	string
username	false	string
verbose	false	boolean

SqoopScheduledImportJob

Name	Required	Schema
appPath	false	string
name	false	string
schedule	false	OozieSchedule
sqoopImport	false	SqoopImport

WorkflowSchedulerConfigurationEntity

Name	Required	Schema
databases	false	Database array
organizationDirectory	false	string
timezones	false	string array

Home | FAQs