Get scheduled jobs for a field

GET/settings/fields/{fieldId}/actions/scheduled_jobs

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get scheduled jobs for a field action (under Metadata).
Fill in the fields below, then reference the result from later steps as {{getScheduledJobsForAField.response.data}}.

Request

Path parameters

fieldIdstringrequired

Specify the unique ID of the custom field.

Query parameters

job_idstring (int64)

Specify the job ID of the scheduled field or picklist action to filter the results.

modulestringrequired

Specify the API name of the module for which you want to retrieve field data. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.

pageinteger (int32)

Specify the page number for paginating the scheduled jobs list.

per_pageinteger (int32)

Specify the number of scheduled jobs to return per page.

Response

Returns 200 with an object. Read it in later steps with {{getScheduledJobsForAField.response.data.<field>}}.

scheduled_jobsarray<object>

Represents the list of scheduled picklist field action jobs retrieved for the specified field.

job_idstring (int64)required

Represents the job id of the scheduler.

moduleobjectrequired2 fields

Represents the lightweight reference to the CRM module targeted by the scheduled job, including the module API name and unique identifier.

actionstringrequired

Represents the scheduler detail action.

One ofDELETE_PICKLIST_OPTIONREPLACE_PICKLIST_OPTIONDELETE_AND_REPLACE_PICKLIST_OPTION

detailsobjectrequired4 fields

Represents the aggregated impact metrics for the scheduled job across records, workflow rules, field dependencies, and dashboard criteria affected by the picklist option change.

messagestringrequired

Represents the message of the scheduler response.

One ofJob completedJob scheduledJob failedJob inprogress

statusstringrequired

Represents the status of the scheduler.

One ofSCHEDULEDFAILEDCOMPLETEDINPROGRESS

infoobject

Represents the pagination metadata for the scheduled jobs list, including per-page size, current page, item count, and whether more records are available.

per_pageinteger (int32)required

Represents the per page count.

countinteger (int32)required

Represents the count of the jobids.

pageinteger (int32)required

Represents the page number.

more_recordsbooleanrequired

Represents the more records available.

json

{
  "scheduled_jobs": [
    {
      "job_id": "string",
      "module": {
        "api_name": "string",
        "id": "string"
      },
      "action": "DELETE_PICKLIST_OPTION",
      "details": {
        "records": {
          "processed": 0,
          "total": 0,
          "failed": 0
        },
        "workflow_rules": {
          "processed": 0,
          "total": 0,
          "failed": 0
        },
        "field_dependency": {
          "processed": 0,
          "total": 0,
          "failed": 0
        },
        "dashboard_criteria": {
          "processed": 0,
          "total": 0,
          "failed": 0
        }
      },
      "message": "Job completed",
      "status": "SCHEDULED"
    }
  ],
  "info": {
    "per_page": 0,
    "count": 0,
    "page": 0,
    "more_records": false
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?