Planning endpoint

Select Planning Candidate

Send this request to the AkôFlow daemon. Authentication is required when an API token is configured.

POST/planning-sessions/{sessionId}/candidates/{candidateId}/select/

Path parameters

sessionId

Identifier used by the registered route.

candidateId

Identifier used by the registered route.

Body

none

This endpoint does not accept a request body.

cURL

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -X POST \
  "${AKOFLOW_API_URL}/planning-sessions/{sessionId}/candidates/{candidateId}/select/"

201 Createdapplication/json

{
  "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": {}
}

*domain.SchedulePlan

Related guide

See the Planning guide for the corresponding Desktop workflow, concepts, and authored request examples.

Generated from the daemon router

This page is generated from internal/api/httpserver/httpserver.go, the registered handler, and JSON-tagged Go structs. Method, path, request fields, response kind, query parameters, media type, and successful status codes stay synchronized with the implementation.