Methods

Objects

jobs

Jobs Service. Get jobs statuses.

Method Description
jobs.cancel Cancel a job
jobs.get Retrieves a job
jobs.mget Retrieves multiple jobs

Methods

jobs.cancel

Description

Cancel a job

Signature

method: jobs.cancel

params: [string id]

Parameters

Parameter Type Description NULL
id string Job ID
Format: hid (Unique object identifier)
NO

Result

Type Description Format/Object
bool Did it work?

jobs.get

Description

Retrieves a job

Signature

method: jobs.get

params: [string id]

Parameters

Parameter Type Description NULL
id string Job ID
Format: hid (Unique object identifier)
NO

Result

Type Description Format/Object
object Job Object: Job

jobs.mget

Description

Retrieves multiple jobs

Signature

method: jobs.mget

params: [array ids]

Parameters

Parameter Type Description NULL
ids array Job IDs
Format: hid (Unique object identifier)
NO

Result

Type Description Format/Object
array Jobs Array of Job objects.