ConnectCloud Developers

List the item templates of a project (tenant:forge:read)

GET /api/forge/v1/projects/{key}/item-templates

Module: Forge · operationId: listForgeItemTemplates · 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 item templates (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • items (array of ItemTemplate, required)
    • body (string, required): Markdown
    • id (string (uuid), required): Template id
    • key (string, required): Template key (templateKey of a new item)
    • labelIds (array of string (uuid), required): Labels it sets
    • name (string, required): Display name
    • position (integer, required): Order in the configuration
    • title (string, required): Title it prefills
    • version (integer, required): Optimistic-locking version; send it with PATCH
    • typeId (string (uuid), nullable): Item type it sets; null = none

Example 200 answer:

{
  "items": [
    {
      "body": "## Beobachtet\n\n## Erwartet\n\n## Schritte zum Nachstellen\n\n1. \n",
      "id": "ac6d7e8f-9a0b-4c1d-8ecf-6a7b8c9d0e01",
      "key": "fehlerbericht",
      "labelIds": [
        "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c04"
      ],
      "name": "Fehlerbericht",
      "position": 0,
      "title": "",
      "typeId": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b04",
      "version": 1
    }
  ]
}

Example request

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

View as Markdown · Interactive reference · OpenAPI