API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · surveys

Survey Schema

Schema-ID
survey
Collection
surveys
Permissions
  • Lesensurvey_view
  • Anlegensurvey_create
  • Ändernsurvey_edit
  • Löschensurvey_delete

Felder

Survey Schema

surveys4 Permissions

Schema for survey/form definitions with embedded questions and logic

titlestringerforderlich
1–200 Zeichen
descriptionstringoptional
max 5000 Zeichennullable
descriptionHtmlstringoptional
nullable
statusstringerforderlich
Werte
DRAFTACTIVEPAUSEDCLOSEDARCHIVED
surveyTypestringoptional
Werte
GENERALCSATNPSONBOARDINGSERVICE_REVIEWCUSTOM
Default: "GENERAL"
surveyNumberstringoptional
nullable
isTemplatebooleanoptional
Default: false
templateIduuidoptional
nullable
questionsobject[]optional
Default: []
questionIduuiderforderlich
sortOrderintegererforderlich
≥ 0
typestringerforderlich
Werte
SHORT_TEXTLONG_TEXTEMAILPHONEURLNUMBERSINGLE_CHOICEMULTIPLE_CHOICEDROPDOWNRATINGNPSDATEDATETIMEFILE_UPLOADYES_NOOPINION_SCALEMATRIXRANKINGLISTSTATEMENT
requiredbooleanerforderlich
Default: false
titlestringerforderlich
1–2000 Zeichen
descriptionstringoptional
max 5000 Zeichennullable
descriptionHtmlstringoptional
nullable
placeholderstringoptional
max 200 Zeichennullable
mediaUrlstringoptional
nullable
mediaTypestringoptional
Werte
IMAGEVIDEO
nullable
configobjectoptional

Type-specific configuration, discriminated by kind

nullable
kindstringoptional
Werte
textnumberchoiceratingnpsdatefileUploadyesNoopinionScalematrixrankingliststatement
minnumberoptional
nullable
maxnumberoptional
nullable
stepnumberoptional
nullable
unitstringoptional
max 50 Zeichennullable
optionsobject[]optional
nullable
optionIduuiderforderlich
labelstringerforderlich
1–500 Zeichen
valuestringerforderlich
1–200 Zeichen
imageUrlstringoptional
nullable
allowOtherbooleanoptional
nullable
randomizebooleanoptional
nullable
maxRatingintegeroptional
2 – 10nullable
iconstringoptional
Werte
STARHEARTTHUMBNUMBER
nullable
labelsobjectoptional
nullable
lowstringoptional
max 100 Zeichen
highstringoptional
max 100 Zeichen
detractorstringoptional
max 100 Zeichennullable
passivestringoptional
max 100 Zeichennullable
promoterstringoptional
max 100 Zeichennullable
includeTimebooleanoptional
nullable
minDatedatetimeoptional
nullable
maxDatedatetimeoptional
nullable
maxFilesintegeroptional
1 – 20nullable
maxSizeMbintegeroptional
1 – 100nullable
allowedTypesstring[]optional
nullable
yesLabelstringoptional
max 100 Zeichennullable
noLabelstringoptional
max 100 Zeichennullable
minLabelstringoptional
max 100 Zeichennullable
maxLabelstringoptional
max 100 Zeichennullable
rowsstring[]optional
nullable
columnsstring[]optional
nullable
allowMultiplebooleanoptional
nullable
itemsstring[]optional
nullable
fieldsobject[]optional
nullable
fieldIduuiderforderlich
keystringerforderlich
1–100 Zeichen
labelstringerforderlich
1–200 Zeichen
typestringerforderlich
Werte
TEXTNUMBEREMAILPHONEURLDATEDROPDOWN
requiredbooleanerforderlich
placeholderstringoptional
max 200 Zeichennullable
optionsstring[]optional
nullable
validationobjectoptional
nullable
minLengthintegeroptional
nullable
maxLengthintegeroptional
nullable
minnumberoptional
nullable
maxnumberoptional
nullable
patternstringoptional
nullable
minItemsintegeroptional
≥ 0nullable
maxItemsintegeroptional
≥ 1nullable
addButtonLabelstringoptional
max 100 Zeichennullable
validationobjectoptional
nullable
minLengthintegeroptional
nullable
maxLengthintegeroptional
nullable
minnumberoptional
nullable
maxnumberoptional
nullable
patternstringoptional
nullable
customErrorMessagestringoptional
max 500 Zeichennullable
translationsobjectoptional
nullable
skillIduuidoptional

Optional skill_definition UUID this question rates; used for explicit skill updates on ticket assignee

nullable
skillScoringModestringoptional

direct = higher answer means stronger skill; inverted = lower answer means stronger skill

Werte
directinvertednull
nullable
logicRulesobject[]optional
Default: []
ruleIduuiderforderlich
sourceQuestionIduuiderforderlich
conditionobjecterforderlich
operatorstringerforderlich
Werte
EQUALSNOT_EQUALSCONTAINSNOT_CONTAINSGREATER_THANLESS_THANIS_ANSWEREDIS_NOT_ANSWEREDINNOT_IN
valueanyoptional
actionobjecterforderlich
typestringerforderlich
Werte
SHOWHIDEJUMP_TOEND_SURVEY
targetQuestionIduuidoptional
nullable
designobjectoptional
nullable
primaryColorstringoptional
max 20 Zeichennullable
backgroundColorstringoptional
max 20 Zeichennullable
backgroundImageUrlstringoptional
nullable
logoUrlstringoptional
nullable
fontFamilystringoptional
Werte
defaultserifmono
nullable
showProgressBarbooleanoptional
Default: true
showQuestionNumbersbooleanoptional
Default: true
layoutstringoptional
Werte
ONE_PER_PAGEALL_AT_ONCESECTIONS
Default: "ALL_AT_ONCE"
colorModestringoptional
Werte
lightdarkauto
Default: "auto"nullable
useTenantBrandingbooleanoptional
Default: true
themestringoptional
Werte
defaultminimalvibrantnatureoceansunsetlavenderslate
nullable
cardRadiusintegeroptional
0 – 30nullable
buttonRadiusintegeroptional
0 – 30nullable
distributionobjectoptional
nullable
publicSlugstringoptional
3–100 Zeichennullable
allowAnonymousbooleanoptional
Default: true
requireAuthbooleanoptional
Default: false
oneResponsePerPersonbooleanoptional
Default: false
deduplicationFieldstringoptional
Werte
emailuserIdipnone
nullable
maxResponsesintegeroptional
≥ 1nullable
passwordstringoptional
max 200 Zeichennullable
passwordHashstringoptional
nullable
allowedDomainsstring[]optional
nullable
embedEnabledbooleanoptional
Default: false
scheduleobjectoptional
nullable
startsAtdatetimeoptional
nullable
endsAtdatetimeoptional
nullable
timezonestringoptional
max 50 Zeichennullable
completionobjectoptional
nullable
thankYouTitlestringoptional
max 500 Zeichennullable
thankYouMessagestringoptional
max 5000 Zeichennullable
redirectUrlstringoptional
max 2000 Zeichennullable
showSummarybooleanoptional
Default: false
remindersobjectoptional
nullable
enabledbooleanoptional
Default: false
intervalDaysintegeroptional
1 – 90nullable
maxRemindersintegeroptional
1 – 10nullable
emailSubjectstringoptional
max 200 Zeichennullable
emailBodystringoptional
max 5000 Zeichennullable
integrationobjectoptional
nullable
triggerOnTicketClosebooleanoptional
Default: false
triggerTicketTypesstring[]optional
nullable
linkToPartyIduuidoptional
nullable
linkToContractIduuidoptional
nullable
languagesstring[]optional
Default: []
translationsobjectoptional
nullable
responseCountintegeroptional
≥ 0Default: 0
completionRatenumberoptional
0 – 100nullable
averageCompletionTimeSecnumberoptional
≥ 0nullable
npsScorenumberoptional
-100 – 100nullable
assignedToIduuidoptional
nullable
orgUnitIduuidoptional
nullable
tagsstring[]optional
nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/surveys — Liste, paginiert + filterbar
  • GET /api/v1/surveys/<id> — Einzelne Entity
  • POST /api/v1/surveys — Anlegen
  • PATCH /api/v1/surveys/<id> — Teil-Update
  • DELETE /api/v1/surveys/<id> — Soft-Delete
  • GET /api/v1/surveys/<id>/timeline — Audit + Aktivitäten

Suche