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

Survey Response Schema

Schema-ID
survey_response
Collection
survey_responses
Permissions
  • Lesensurvey_response_view
  • Anlegensurvey_response_create
  • Ändernsurvey_response_edit
  • Löschensurvey_response_delete
Beziehungen

Felder

Survey Response Schema

survey_responses4 Permissions

Schema for individual survey response submissions

surveyIduuiderforderlich→ survey

FK to survey

statusstringerforderlich
Werte
IN_PROGRESSCOMPLETEDABANDONED
respondentobjectoptional
nullable
userIduuidoptional
nullable
emailstringoptional
max 320 Zeichennullable
namestringoptional
max 200 Zeichennullable
ipAddressstringoptional
max 45 Zeichennullable
userAgentstringoptional
max 500 Zeichennullable
languagestringoptional
max 10 Zeichennullable
answersobject[]optional
Default: []
questionIduuiderforderlich

References SurveyQuestion.questionId

valueanyerforderlich

Answer value. Type depends on question: string, number, boolean, string[], Record<string,string>[], Record<string,unknown>[]

answeredAtdatetimeerforderlich
timeSecnumberoptional

Time spent on this question in seconds

≥ 0nullable
startedAtdatetimeoptional
nullable
completedAtdatetimeoptional
nullable
lastActivityAtdatetimeoptional
nullable
totalTimeSecnumberoptional
≥ 0nullable
pageHistoryinteger[]optional
nullable
resumeTokenstringoptional
max 200 Zeichennullable
linkedTicketIduuidoptional
nullable
linkedPartyIduuidoptional
nullable
linkedContractIduuidoptional
nullable
invitationIduuidoptional
nullable
reminderCountintegeroptional
≥ 0nullable

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

Suche