ConnectCloud Developers

List the section definitions of a project (tenant:forge:read)

GET /api/forge/v1/projects/{key}/section-defs

Module: Forge · operationId: listForgeSectionDefs · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

Requires tenant:forge:read and a project the caller sees.

Parameters

Name In Type Required Description
key path string yes Project key (e.g. APP)

Responses

  • 200 The section definitions (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • items (array of SectionDef, required)
    • id (string (uuid), required): Section definition id
    • key (string, required): Section key; never changes
    • kind (string, required): markdown or checklist (one of markdown, checklist)
    • label (string, required): Display label
    • placement (string, required): Where the portal shows it: a tab or the side column (one of tab, aside)
    • position (integer, required): Order in the configuration
    • typeKeys (array of string, required): Item type keys the section applies to; empty = every type
    • version (integer, required): Optimistic-locking version; send it with PATCH

Example 200 answer:

{
  "items": [
    {
      "id": "bd7e8f9a-0b1c-4d2e-9fd0-7b8c9d0e1f01",
      "key": "plan",
      "kind": "markdown",
      "label": "Plan",
      "placement": "tab",
      "position": 0,
      "typeKeys": [],
      "version": 1
    },
    {
      "id": "bd7e8f9a-0b1c-4d2e-9fd0-7b8c9d0e1f02",
      "key": "agent_notes",
      "kind": "markdown",
      "label": "Notizen für Agenten",
      "placement": "tab",
      "position": 1,
      "typeKeys": [],
      "version": 1
    },
    {
      "id": "bd7e8f9a-0b1c-4d2e-9fd0-7b8c9d0e1f03",
      "key": "acceptance",
      "kind": "checklist",
      "label": "Akzeptanzkriterien",
      "placement": "tab",
      "position": 2,
      "typeKeys": [],
      "version": 1
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/section-defs' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI