POST/projects/api/v3/planning/autoschedule/preview.json

Optimise without persisting; return the plan.

Body Params

Request is the shared request body accepted by all four /planning/autoschedule action routes (validate, preview, highlights and persist).

    • Name
      config
      Type
      object
      Description
      Config holds optional tuning parameters for a scheduling request. Every field is an optional pointer: an absent field falls back to its server-side default, which is distinct from sending an explicit zero.
    • Name
      lockedTaskIds
      Type
      array
      Description
      LockedTaskIDs lists tasks whose current assignees must be preserved: the scheduler may move their dates but will not reassign them.
    • Name
      projectIds
      Type
      array
      Description
      ProjectIDs is the set of projects to schedule. Exactly one project id is required; scheduling more than one project in a single request is not currently supported.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      AutoScheduleResponse is the scheduling result. It offers two complementary views: per-user-per-day allocations (Users) and per-task date + assignee summaries (Tasks). All input tasks appear either in Tasks or in UnscheduledTasks (never both, never neither).
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      403
      Type
      object
      Schema
      Description
      403 Forbidden
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      409
      Type
      object
      Schema
      Description
      409 Conflict
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      422
      Type
      object
      Schema
      Description
      422 Unprocessable Entity
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      500
      Type
      object
      Schema
      Description
      500 Internal Server Error
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      502
      Type
      object
      Schema
      Description
      502 Bad Gateway
      ErrorResponse defines how []Error should be marshaled to JSON.

    Examples

    200 OK

    AutoScheduleResponse
    {
  "status": "string",
  "tasks": [
    {
      "assigneeIds": [
        0
      ],
      "endDate": "string",
      "projectId": 0,
      "startDate": "string",
      "taskId": 0
    }
  ],
  "unscheduledTasks": [
    0
  ],
  "users": [
    {
      "dates": [
        {
          "date": "string",
          "tasks": [
            {
              "estimatedTime": 0,
              "taskId": 0
            }
          ]
        }
      ],
      "userId": 0
    }
  ]
}
    Download Swagger