Web API

JobManager

Other API in Package

User

Internal Tunnel

Tunnel

List of Classes

WebController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

NavigatorResponse

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Pin

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Response

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Method Summary
Job createJob(String name, String workflow)

Creates a new job and immediately executes it.

Job createJob(String name, String workflow, Date startDate, Payload payload)

Creates a new job.

Job createJob(String name, String workflow, Payload payload)

Creates a new job and immediately executes it.

boolean deleteJob(String jobId)

Deletes the job with the specified id. Returns false if the job is not deleted. Jobs with a status of Running or Queued cannot be deleted. Jobs with a status of Running can be deleted if they are 'stuck' for an hour or more.

  deleteJobs(String[] jobIds)

Deletes the jobs with the specified ids.

Job getJob(String jobId)

Returns the job with the specified id.

SystemDataView getJobs()

Returns a system dataview for accessing jobs.

Job getLastJob(String name)

Returns the job with the given name and having a schedule furthest in the future.

String toString()

Returns a description of this object.

Method Detail


Job createJob(String name, String workflow)

Creates a new job and immediately executes it.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 80
  • String   workflow Required parameter. Maximum allowed size of parameter: 100

Returns:  Job

Since: 12-21-2012

top

Job createJob(String name, String workflow, Date startDate, Payload payload)

Creates a new job.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 80
  • String   workflow Required parameter. Maximum allowed size of parameter: 100
  • Date   startDate
  • Payload   payload

Returns:  Job

Since: 12-21-2012

top

Job createJob(String name, String workflow, Payload payload)

Creates a new job and immediately executes it.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 80
  • String   workflow Required parameter. Maximum allowed size of parameter: 100
  • Payload   payload Required parameter.

Returns:  Job

Since: 01-07-2013

top

boolean deleteJob(String jobId)

Deletes the job with the specified id. Returns false if the job is not deleted. Jobs with a status of Running or Queued cannot be deleted. Jobs with a status of Running can be deleted if they are 'stuck' for an hour or more.

Parameters:

  • String   jobId

Returns:  boolean

Since: 12-21-2012

top

deleteJobs(String[] jobIds)

Deletes the jobs with the specified ids.

Parameters:

  • String[]   jobIds Required parameter.

Since: 06-05-2013

top

Job getJob(String jobId)

Returns the job with the specified id.

Parameters:

  • String   jobId

Returns:  Job

Since: 12-21-2012

top

SystemDataView getJobs()

Returns a system dataview for accessing jobs.

Returns:  SystemDataView


DataList Name: Jobs
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
name String  
errorMessage String  
status String  
scheduleDate Date  
runDate Date  
workflow String  
runCount Medium integer  

Since: 12-21-2012

top

Job getLastJob(String name)

Returns the job with the given name and having a schedule furthest in the future.

Parameters:

  • String   name

Returns:  Job

Since: 09-08-2017

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-21-2012

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM