Zoho: Get scheduled jobs for a field
Zoho fields.getScheduledJobs: arguments, response, policy and SDK examples.
← Fields operations · Get started
Operation zoho.getscheduledjobs
Provider route: GET /crm/v8/settings/fields/{fieldId}/actions/scheduled_jobs. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { ZohoIntegration } from "@alter-ai/zoho";
async function execute(input: Parameters<ZohoIntegration["fields"]["getScheduledJobs"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.fields.getScheduledJobs(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_zoho import ZohoIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.fields.get_scheduled_jobs(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.fieldId | string | Required within parent | Maximum length: 255 |
query | object | Required within parent | Additional keys: not allowed |
query.job_id | string | Optional | Format: int64 |
query.module | string | Required within parent | The API name of the module to which the field belongs. Maximum length: 30 |
query.page | integer | Optional | Format: int32 |
query.per_page | integer | Optional | Format: int32 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get scheduled jobs for a field — response body — info, scheduled jobs |
$ (anyOf 2) | null | Alternative |
Referenced models: Get scheduled jobs for a field — response body — info, scheduled jobs
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Get scheduled jobs for a field — response body — info, scheduled jobs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response body for the scheduled jobs request, containing the list of scheduled picklist field action jobs and pagination details. Additional keys: not allowed |
info | Model | Required within parent | Expand Get scheduled jobs for a field — response body — info, scheduled jobs info |
scheduled_jobs | array | Required within parent | Represents the list of scheduled picklist field action jobs retrieved for the specified field. Maximum items: 200 |
scheduled_jobs[] | Model | Each item | Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item |
Referenced models: Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item, Get scheduled jobs for a field — response body — info, scheduled jobs info
Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a scheduled job for a picklist field action (delete, replace, or delete-and-replace), including the job ID, target module, impact details, status, and message. Additional keys: not allowed |
action | string | Required within parent | Represents the scheduler detail action. Known values: DELETE_PICKLIST_OPTION, REPLACE_PICKLIST_OPTION, DELETE_AND_REPLACE_PICKLIST_OPTION Maximum length: 255 |
details | Model | Required within parent | Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details |
job_id | string | Required within parent | Represents the job id of the scheduler. Format: int64 |
message | string | Required within parent | Represents the message of the scheduler response. Known values: Job completed, Job scheduled, Job failed, Job inprogress Maximum length: 255 |
module | Model | Required within parent | Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item module |
status | string | Required within parent | Represents the status of the scheduler. Known values: SCHEDULED, FAILED, COMPLETED, INPROGRESS Maximum length: 255 |
$ (allOf 1) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 2) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 3) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 4) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 5) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 6) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 7) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 8) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 9) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 10) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 11) | JSON | All variants apply | Represents the description for allOf nested. |
$ (allOf 12) | JSON | All variants apply | Represents the description for allOf nested. |
Referenced models: Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item module, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details
Get scheduled jobs for a field — response body — info, scheduled jobs info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination metadata for the scheduled jobs list, including per-page size, current page, item count, and whether more records are available. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the count of the jobids. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Represents the more records available. |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Represents the page number. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Required within parent | |
per_page (anyOf 1) | integer | Alternative | Represents the per page count. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the lightweight reference to the CRM module targeted by the scheduled job, including the module API name and unique identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the module. Maximum length: 255 |
id | string | Required within parent | Represents the module Id. Maximum length: 20 Minimum length: 13 |
Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the aggregated impact metrics for the scheduled job across records, workflow rules, field dependencies, and dashboard criteria affected by the picklist option change. Additional keys: not allowed |
dashboard_criteria | Model | Optional | Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details dashboard criteria |
field_dependency | Model | Optional | Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details field dependency |
records | Model | Required within parent | Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details records |
workflow_rules | Model | Optional | Expand Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details workflow rules |
Referenced models: Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details dashboard criteria, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details field dependency, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details records, Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details workflow rules
Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details dashboard criteria
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the summary of dashboard criteria impact for the job, including counts of total evaluated, processed, and failed criteria. Additional keys: not allowed |
failed | JSON | Required within parent | |
failed (anyOf 1) | integer | Alternative | Indicates the total number of records that failed to process during the dashboard criteria evaluation. Format: int32 |
failed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processed | JSON | Required within parent | |
processed (anyOf 1) | integer | Alternative | Represents the processed records. Format: int32 |
processed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Represents the total number of records submitted for processing in the dashboard criteria evaluation, encompassing both successful and failed records. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get scheduled jobs for a field — response body — info, scheduled jobs scheduled jobs item details field dependency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the summary of field dependency impact for the job, including counts of total evaluated, processed, and failed dependencies. Additional keys: not allowed |
failed | JSON | Required within parent | |
failed (anyOf 1) | integer | Alternative | Represents the failed field dependencies. Format: int32 |
failed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processed | JSON | Required within parent | |
processed (anyOf 1) | integer | Alternative | Represents the processed field dependencies. Format: int32 |
processed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Represents the total field dependencies. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getscheduledjobs. Catalog operation: getScheduledJobs. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
No-content response statuses: [204]