Planning endpoint

Create Plan

POST/schedule-plans/

Request body

application/json

See the request guidance below for a valid body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X POST \
  "${AKOFLOW_API_URL}/schedule-plans/"

Supply a valid request.json before running this command.

201 Createdapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

{
  "id": "string",
  "workflowVersionId": "string",
  "executionScopeId": "string",
  "networkTopologyId": "string",
  "source": "string",
  "algorithm": "string",
  "algorithmVersion": "string",
  "objective": "string",
  "deadlineSeconds": 0,
  "budget": 0,
  "predicted": {
    "makespanSeconds": 0,
    "cost": 0,
    "feasible": true
  },
  "assignments": [
    {
      "id": "string",
      "planId": "string",
      "activityId": "string",
      "resourceId": "string",
      "coreId": "string",
      "slotId": "string",
      "orderOnResource": 0,
      "priority": 0,
      "predictedReadyAt": 0,
      "predictedStartAt": 0,
      "predictedFinishAt": 0,
      "predictedRuntimeSeconds": 0,
      "predictedTransferSeconds": 0,
      "predictedCost": 0,
      "metadata": {}
    }
  ],
  "lifecycleActions": [
    {
      "id": "string",
      "schedulePlanId": "string",
      "capacityTargetId": "string",
      "cloudInstanceId": "string",
      "action": "string",
      "earliestStart": 0,
      "expectedDuration": 0,
      "dependsOn": [
        "string"
      ],
      "metadata": {}
    }
  ],
  "assignmentCount": 0,
  "metadata": {}
}

Runnable SimGrid request

The first-run tutorial submits akoflow-examples/simulation/plan-request.yaml in a six-request sequence. Follow that order so referenced IDs exist.

Handler-checked behavior

Returns the saved plan. If plan.networkTopologyId is empty, the server fills it from networkTopology.id. Submitted predictions are saved without recalculation.

Related guide

See the Planning guide for related tasks and context.