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 ofdesk.config/v1)categories(array of object): Categoriesdescription(string): Description of the bundleenums(object): Value lists by kindfields(array of object): Custom fieldskey(string): Key of the bundle (templates)labels(array of object): Labelsmatrix(object): Priority matrix (impact × urgency)name(string): Name of the bundleprefix(string): Suggested prefix for conflicting keyspriorities(array of object): PrioritiesprojectTemplates(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 keyprojectTypes(array of object): Project types: workflow, taskSpace and taskType are keys, layout "cf.", billing as in the project type settingsspaces(array of object): Spacesteams(array of object): Teamstypes(array of object): Item typesworkflows(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"