Skip to main content
POST
/
api
/
plan
/
{boardId}
/
batch
Batch-plans items into a cycle. All-or-nothing: if any item fails validation, none are saved.
curl --request POST \
  --url https://{tenant}.ekso.app/api/plan/{boardId}/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cycleId": "<string>",
  "items": [
    {
      "itemId": "<string>",
      "resourceId": "<string>"
    }
  ]
}
'
{
  "planned": 123,
  "cycleId": "<string>",
  "errors": [
    {
      "itemId": "<string>",
      "reason": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Path Parameters

boardId
string
required

The board ID.

Body

Cycle ID and list of items to plan.

cycleId
string
items
object[]

Response

Items planned successfully (or error list on failure).

planned
integer<int32>
cycleId
string
errors
object[]