Suggest Time

Overview

Suggests optimal time slots for one or more jobs

Category: Scheduling

Use this action to suggest optimal time slots for one or more jobs. Only jobIds is required: schedule windows and region are auto-fetched from each job. Pass resourceIds to limit candidates, or omit to consider all resources. Optionally provide scheduleStart/scheduleEnd to override the search window.

Request

Parameter Type Required Description Example
jobIds array of string Yes The IDs of jobs to suggest times for
Min items: 1		 ["0014ccb7-73ad-40e1-9282-2c492a0f313a"]
resourceIds array of string No Resource IDs to consider. Omit for all. ["00148d32-10ef-4264-adfe-0ff3ece68d92"]
scheduleStart string No Schedule window start in ISO 8601 UTC. Auto-fetched from job if omitted. 2026-01-15T00:00:00.000Z
scheduleEnd string No Schedule window end in ISO 8601 UTC. Auto-fetched from job if omitted. 2026-01-22T00:00:00.000Z

Response

This action’s output is available as $suggestTime in JSONata expressions. See Response format for the standard result.data / result.errors structure and error handling patterns.

Field Type Description
result.data.* object Suggestions keyed by job ID, or null if there are errors

Example output:

{
  "0014ccb7-73ad-40e1-9282-2c492a0f313a": {
    "suggestions": [
      {
        "start": "2026-01-15T09:00:00.000Z",
        "end": "2026-01-15T10:00:00.000Z",
        "score": 95
      }
    ]
  }
}