ConnectCloud Developers

List the projects an item or ticket can be handed to (tenant:forge:read or tenant:forge:intake)

GET /api/forge/v1/handoff-targets

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

Requires tenant:forge:read, write, admin or intake. The active projects, each with its item types and default type, that a handoff from origin may go to: desk (default; desk's handoff to development, called with the person's token) – projects where the caller may create items (forge write or a membership in a visible project) or, with tenant:forge:intake, that accept intake (acceptsIntake); forge (forge's own handoff) – only projects where the caller may create items. Desk targets come from desk's bootstrap.

Parameters

Name In Type Required Description
origin query string (one of desk, forge; default "desk")

Responses

  • 200 Targets (application/json)
  • 400 Error (application/json)
  • 403 Error (application/json)

Fields of the 200 answer:

  • items (array of HandoffTarget, required)
    • acceptsIntake (boolean, required): The project accepts desk tickets from intake-only callers
    • id (string (uuid), required): Project id
    • key (string, required): Project key
    • name (string, required): Project name
    • types (array of object, required): Item types of the project
      • key (string, required): Item type key
      • name (string, required): Item type name
    • defaultTypeKey (string): Key of the default item type

Example 200 answer:

{
  "items": [
    {
      "acceptsIntake": true,
      "defaultTypeKey": "aufgabe",
      "id": "0b6c1e1e-3f0b-4e8e-9f3f-1d2c3b4a5f60",
      "key": "APP",
      "name": "Kundenportal-App",
      "types": [
        {
          "key": "epic",
          "name": "Epic"
        },
        {
          "key": "story",
          "name": "Story"
        },
        {
          "key": "aufgabe",
          "name": "Aufgabe"
        },
        {
          "key": "fehler",
          "name": "Fehler"
        },
        {
          "key": "subtask",
          "name": "Sub-Task"
        }
      ]
    },
    {
      "acceptsIntake": false,
      "defaultTypeKey": "aufgabe",
      "id": "3e5f7a9b-1c2d-4e3f-8a5b-7c9d1e3f5a7b",
      "key": "OPS",
      "name": "Plattform-Betrieb",
      "types": [
        {
          "key": "epic",
          "name": "Epic"
        },
        {
          "key": "story",
          "name": "Story"
        },
        {
          "key": "aufgabe",
          "name": "Aufgabe"
        },
        {
          "key": "fehler",
          "name": "Fehler"
        }
      ]
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/forge/v1/handoff-targets' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI