ConnectCloud Developers

Change a section definition (tenant:forge:write and maintainer, or tenant:forge:admin)

PATCH /api/forge/v1/projects/{key}/section-defs/{id}

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

Same permission as creating. version is required (409 version_conflict); keys never change.

Parameters

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

Request body

application/json (required)

  • key (string): Create: section key; fixed afterwards
  • kind (string): markdown (default) or checklist (one of markdown, checklist)
  • label (string): Display label (max length 80)
  • placement (string): tab (default) or aside (one of tab, aside)
  • typeKeys (array of string): Item type keys; empty = every type
  • version (integer): PATCH: the version the change is based on

Example:

{
  "placement": "aside",
  "version": 1
}

Responses

  • 200 Changed (application/json)
  • 400 Error (application/json)
  • 403 Error (application/json)
  • 404 Error (application/json)
  • 409 Error (application/json)

Fields of the 200 answer:

  • 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:

{
  "id": "bd7e8f9a-0b1c-4d2e-9fd0-7b8c9d0e1f03",
  "key": "acceptance",
  "kind": "checklist",
  "label": "Akzeptanzkriterien",
  "placement": "tab",
  "position": 2,
  "typeKeys": [],
  "version": 1
}

Example request

curl -X PATCH 'https://api.mbcom.cloud/api/forge/v1/projects/string/section-defs/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"placement":"aside","version":1}'

View as Markdown · Interactive reference · OpenAPI