ConnectCloud Developers

Export the configuration as a portable bundle (desk:admin)

GET /api/desk/v1/bundle

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

Responses

  • 200 Bundle (application/json)

Fields of the 200 answer:

  • format (string, required): Format of the bundle (one of desk.config/v1)
  • categories (array of object): Categories
  • description (string): Description of the bundle
  • enums (object): Value lists by kind
  • fields (array of object): Custom fields
  • key (string): Key of the bundle (templates)
  • labels (array of object): Labels
  • matrix (object): Priority matrix (impact × urgency)
  • name (string): Name of the bundle
  • prefix (string): Suggested prefix for conflicting keys
  • priorities (array of object): Priorities
  • projectTemplates (array of object): Project templates: type is the project type key; blueprint tasks name their typeId by type key, blueprint fields are keyed by field key
  • projectTypes (array of object): Project types: workflow, taskSpace and taskType are keys, layout "cf.", billing as in the project type settings
  • spaces (array of object): Spaces
  • teams (array of object): Teams
  • types (array of object): Item types
  • workflows (array of object): Workflows

Example 200 answer:

{
  "categories": [
    {
      "path": [
        "Netzwerk",
        "WLAN"
      ]
    }
  ],
  "description": "Export der Desk-Konfiguration",
  "fields": [
    {
      "key": "betroffenes_system",
      "kind": "text",
      "label": "Betroffenes System"
    }
  ],
  "format": "desk.config/v1",
  "key": "muster-it",
  "labels": [
    {
      "color": "warning",
      "name": "vor-ort"
    }
  ],
  "name": "Konfiguration Muster IT",
  "prefix": "",
  "priorities": [
    {
      "color": "neutral",
      "key": "niedrig",
      "label": "Niedrig",
      "rank": 1
    },
    {
      "color": "info",
      "isDefault": true,
      "key": "normal",
      "label": "Normal",
      "rank": 2
    },
    {
      "color": "warning",
      "key": "hoch",
      "label": "Hoch",
      "rank": 3
    },
    {
      "color": "error",
      "key": "kritisch",
      "label": "Kritisch",
      "rank": 4
    }
  ],
  "projectTemplates": [],
  "projectTypes": [],
  "spaces": [
    {
      "defaultType": "serviceanfrage",
      "key": "SUP",
      "name": "Support",
      "types": [
        "stoerung",
        "serviceanfrage"
      ]
    }
  ],
  "teams": [
    {
      "key": "first-level",
      "name": "Service Desk"
    }
  ],
  "types": [
    {
      "focus": "conversation",
      "key": "stoerung",
      "level": 1,
      "name": "Störung",
      "workflow": "service"
    }
  ],
  "workflows": [
    {
      "key": "service",
      "name": "Service",
      "statuses": [
        {
          "color": "info",
          "key": "neu",
          "label": "Neu",
          "phase": "new"
        },
        {
          "closed": true,
          "color": "success",
          "key": "geloest",
          "label": "Gelöst",
          "phase": "done"
        }
      ]
    }
  ]
}

Example request

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

View as Markdown · Interactive reference · OpenAPI