Methods
Objects
Jobs Service. Get jobs statuses.
| Method | Description |
|---|---|
| jobs.cancel | Cancel a job |
| jobs.get | Retrieves a job |
| jobs.mget | Retrieves multiple jobs |
jobs.cancel
Cancel a job
method: jobs.cancel
params: [string id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Job ID Format: hid (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Did it work? |
jobs.get
Retrieves a job
method: jobs.get
params: [string id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Job ID Format: hid (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | Job | Object: Job |
jobs.mget
Retrieves multiple jobs
method: jobs.mget
params: [array ids]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| ids | array |
Job IDs Format: hid (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| array | Jobs | Array of Job objects. |