Die Bildschirmaufnahmen zeigen die englische Benutzeroberfläche.
Für API sind sowohl ein Scope als auch aktuelle Umfrage-/Arbeitsbereichsberechtigungen erforderlich. surveys:read liest Definitionen, surveys:write bearbeitet und übermittelt die Überprüfung, surveys:publish prüft/veröffentlicht und ändert Endzustände, surveys:results liest zulässige Ergebnisse und surveys:export erstellt private CSV-Exporte. Die Anmeldung externer Teilnehmer ist kein API-Schlüssel; REST macht keinen Antwortübermittlungsendpunkt oder Teilnehmeridentitätswechsel verfügbar.
POST erstellt einen Entwurf aus title und primary_language; optional placement platziert es in einem Arbeitsbereich, der Hostberechtigungen unterliegt. primary_language muss installiert sein. PATCH sendet den gesamten definition, keinen Teilfragment. Es enthält settings, pages, texts und rules; UUIDs verbinden Fragen, Auswahlmöglichkeiten und Übersetzungen. languages/enabled_languages verwenden installierte Sprachen und die Installation erzwingt ihre Zeitzone.
GET die Umfrage vor jedem Update. Senden Sie survey.lock_version als version und revision.uuid als revision für Übergänge. Umfrageergebnisse/Exporte haben kein ETag; Beim Authoring wird eine eigene optimistische Sperre verwendet. Ein veralteter version gibt 409 zurück. meaning_unchanged=true umgeht den Schutz bereits erfasster Antworten nicht.
Die einzelnen Aktionen unten sind submit-review, return-review, publish, close, archive, withdraw, copy, delete, discard-draft, restore. Senden Sie confirmed=true, wenn eine Bestätigung erforderlich ist. Die Einreichung wartet auf einen Herausgeber; Nur eine veröffentlichte, offene Umfrage akzeptiert Antworten. copy gibt einen neuen Entwurf UUID ohne Antworten zurück. Das Löschen/Verwerfen eines neuen Entwurfs ist wiederherstellbar; Nur für Administratoren restore stellt eine zuvor veröffentlichte, geschlossene Umfrage wieder her. Administratoren können die Version einer gelöschten Umfrage aus der Liste state=deleted abrufen.
Listen verwenden q, state, page, per_page (Standard 25, maximal 100). Die Ergebnisse verwenden lang, from/to als YYYY-MM-DD, page und per_page (Standard 10, maximal 25); Datumsfilter erfordern Verwaltungsrechte. results paginiert Fragen, während responses Einsendungen paginiert. Für Roheinreichungen ist eine Verwaltungsberechtigung erforderlich, nicht nur der Zugriff auf öffentliche Ergebnisse.
CSV verwendet mode=aggregate oder responses, Sprache und optionale Datumsangaben. include_identity=true gilt nur für identifizierte Antworten und einen autorisierten Manager. Die Antwort gibt einen privaten, ablaufenden Wert token und expires zurück. Speichern Sie das Token privat und laden Sie es als derselbe autorisierte Benutzer herunter. Alle Umfrageantworten verwenden Cache-Control: private, no-store. Das Beispiel PATCH enthält eine vollständig gültige Definition; Ersetzen Sie den Übersetzungsschlüssel der Umfrage UUID durch Ihren eigenen UUID.
Operationen und verifizierte Beispiele
GET /api/v1/surveys
Zweck: Gibt nur begrenzte autorisierte Definitionen zurück.
Berechtigung: surveys:read. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Abfrageparameter: page, per_page, q, state.
Körper: keine zusätzlichen Eingabefelder; Folgen Sie dem Beispiel.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/surveys?q=API&page=1&per_page=10"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"items": [],
"total": 0,
"page": 1,
"pages": 1,
"per_page": 10,
"can_create": true,
"can_restore": true
},
"meta": {
"request_id": "d0b8ee7dfb5cb00730d6e9c3bb6281d7"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys
Zweck: Unterstützt die eigenständige oder explizit autorisierte Arbeitsbereichs-Platzierung.
Berechtigung: surveys:write. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: placement, primary_language, title. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"title": "API povratne informacije",
"primary_language": "hr"
}' \
"$BASE_URL/api/v1/surveys"
Tatsächliche Antwort: HTTP 201.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f"
},
"meta": {
"request_id": "e25c296217ac34f4d26cfc3085244246"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403, 422. Statusbedeutungen und Problemreaktionen finden Sie unter gemeinsame Regeln.
GET /api/v1/surveys/{survey}
Zweck: Gibt nur begrenzte autorisierte Definitionen zurück.
Berechtigung: surveys:read. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Körper: keine zusätzlichen Eingabefelder; Folgen Sie dem Beispiel.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"survey": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"owner_user_id": 1,
"primary_language": "hr",
"timezone": "UTC",
"state": "draft",
"audience_mode": "application",
"privacy_mode": "anonymous",
"results_visibility": "private",
"draft_revision_uuid": "f7134760-fb72-46be-8753-37e4fc658f0f",
"published_revision_uuid": null,
"lock_version": 0,
"structure_locked": 0,
"accepted_count": 0,
"opens_at": null,
"closes_at": null,
"created_at": "2026-11-06 22:11:23",
"updated_at": "2026-11-06 22:11:23"
},
"revision": {
"uuid": "f7134760-fb72-46be-8753-37e4fc658f0f",
"survey_uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"revision_number": 1,
"state": "draft",
"title": "API povratne informacije",
"structure_fingerprint": "643d5437104296e21d906ecb15b2c96ad278f20cfc4af53b12bb6069bd853726",
"content_fingerprint": "500f09259ca330d0833105171bd86f93ede50f7e0b0f8d72352b55a249386a85",
"created_by_user_id": 1,
"reviewed_by_user_id": null,
"created_at": "2026-11-06 22:11:23"
},
"definition": {
"settings": {
"languages": [
"hr"
],
"enabled_languages": [
"hr"
],
"timezone": "Europe/Zagreb",
"opens_at": null,
"closes_at": null,
"audience_mode": "application",
"privacy_mode": "anonymous",
"results_visibility": "private",
"public_cookie_days": 30,
"results_timing": "during",
"results_audience": "managers",
"admission": [],
"invitees_required": false,
"show_question_codes": true,
"show_choice_codes": true
},
"pages": [],
"texts": {
"hr": {
"eaf6b9bc-2459-4849-8102-7343e047a09f": {
"title": "API povratne informacije"
}
}
},
"rules": []
},
"rights": {
"manage": true,
"publish": true,
"preview": true,
"delete": true
},
"versions": [
{
"uuid": "f7134760-fb72-46be-8753-37e4fc658f0f",
"survey_uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"revision_number": 1,
"state": "draft",
"title": "API povratne informacije",
"structure_fingerprint": "643d5437104296e21d906ecb15b2c96ad278f20cfc4af53b12bb6069bd853726",
"content_fingerprint": "500f09259ca330d0833105171bd86f93ede50f7e0b0f8d72352b55a249386a85",
"created_by_user_id": 1,
"reviewed_by_user_id": null,
"created_at": "2026-11-06 22:11:23"
}
]
},
"meta": {
"request_id": "db784bd3b231d1f5865b767b33c2e884"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403, 404. Statusbedeutungen und Problemreaktionen finden Sie unter gemeinsame Regeln.
PATCH /api/v1/surveys/{survey}
Zweck: Erfordert die optimistische Version und behält veröffentlichte/gesammelte Invarianten bei.
Berechtigung: surveys:write. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: definition, meaning_unchanged, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request PATCH \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 0,
"definition": {
"settings": {
"languages": [
"hr",
"en"
],
"enabled_languages": [
"hr",
"en"
],
"timezone": "Europe/Zagreb",
"opens_at": null,
"closes_at": null,
"audience_mode": "public",
"privacy_mode": "anonymous",
"results_visibility": "private",
"public_cookie_days": 30,
"results_timing": "during",
"results_audience": "public",
"admission": [],
"invitees_required": false,
"show_question_codes": false,
"show_choice_codes": false
},
"pages": [
{
"uuid": "10000000-0000-4000-8000-000000000001",
"require_complete": true,
"blocks": [
{
"uuid": "10000000-0000-4000-8000-000000000002",
"kind": "html"
},
{
"uuid": "10000000-0000-4000-8000-000000000003",
"kind": "question",
"question": {
"uuid": "10000000-0000-4000-8000-000000000004",
"type": "radio",
"alias": "EASE",
"required": true,
"settings": [],
"choices": [
{
"uuid": "10000000-0000-4000-8000-000000000005",
"code": "1",
"kind": "regular"
},
{
"uuid": "10000000-0000-4000-8000-000000000006",
"code": "2",
"kind": "regular"
},
{
"uuid": "10000000-0000-4000-8000-000000000007",
"code": "3",
"kind": "regular"
}
]
}
},
{
"uuid": "10000000-0000-4000-8000-000000000008",
"kind": "question",
"question": {
"uuid": "10000000-0000-4000-8000-000000000009",
"type": "rating",
"alias": "RATING",
"required": true,
"settings": {
"min": 1,
"max": 5
},
"choices": []
}
},
{
"uuid": "10000000-0000-4000-8000-000000000010",
"kind": "question",
"question": {
"uuid": "10000000-0000-4000-8000-000000000011",
"type": "textarea",
"alias": "COMMENT",
"required": false,
"settings": {
"max_length": 1000
},
"choices": []
}
}
]
}
],
"texts": {
"en": {
"10000000-0000-4000-8000-000000000001": {
"title": "Your experience"
},
"10000000-0000-4000-8000-000000000002": {
"html": "<h2>Your feedback matters</h2><p>This example survey was created through the API and published through the normal review workflow. It is public and anonymous. Please enter no personal information.</p>"
},
"10000000-0000-4000-8000-000000000005": {
"label": "Easy"
},
"10000000-0000-4000-8000-000000000006": {
"label": "Mostly easy"
},
"10000000-0000-4000-8000-000000000007": {
"label": "Needs improvement"
},
"10000000-0000-4000-8000-000000000004": {
"text": "How easy is it to use surveys?",
"help_html": ""
},
"10000000-0000-4000-8000-000000000009": {
"text": "Your overall rating",
"help_html": ""
},
"10000000-0000-4000-8000-000000000011": {
"text": "What would you improve?",
"help_html": ""
},
"eaf6b9bc-2459-4849-8102-7343e047a09f": {
"title": "Workshop feedback"
}
},
"hr": {
"10000000-0000-4000-8000-000000000001": {
"title": "Vaše iskustvo"
},
"10000000-0000-4000-8000-000000000002": {
"html": "<h2>Vaše mišljenje nam je važno</h2><p>Ova je ogledna anketa izrađena putem API-ja i objavljena kroz redovni tijek pregleda. Javna je i anonimna. Ne unosite osobne podatke.</p>"
},
"10000000-0000-4000-8000-000000000005": {
"label": "Jednostavno"
},
"10000000-0000-4000-8000-000000000006": {
"label": "Uglavnom jednostavno"
},
"10000000-0000-4000-8000-000000000007": {
"label": "Treba poboljšati"
},
"10000000-0000-4000-8000-000000000004": {
"text": "Koliko vam je jednostavno koristiti ankete?",
"help_html": ""
},
"10000000-0000-4000-8000-000000000009": {
"text": "Vaša ukupna ocjena",
"help_html": ""
},
"10000000-0000-4000-8000-000000000011": {
"text": "Što biste poboljšali?",
"help_html": ""
},
"eaf6b9bc-2459-4849-8102-7343e047a09f": {
"title": "Povratna informacija o radionici"
}
}
},
"rules": []
}
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"survey": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"owner_user_id": 1,
"primary_language": "hr",
"timezone": "UTC",
"state": "draft",
"audience_mode": "application",
"privacy_mode": "anonymous",
"results_visibility": "private",
"draft_revision_uuid": "f7134760-fb72-46be-8753-37e4fc658f0f",
"published_revision_uuid": null,
"lock_version": 1,
"structure_locked": 0,
"accepted_count": 0,
"opens_at": null,
"closes_at": null,
"created_at": "2026-11-06 22:11:23",
"updated_at": "2026-11-06 22:11:43"
},
"revision": {
"uuid": "f7134760-fb72-46be-8753-37e4fc658f0f",
"survey_uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"revision_number": 1,
"state": "draft",
"title": "Povratna informacija o radionici",
"structure_fingerprint": "416e9b4b28f5f95ec65ba960d5a43f223fa6c228c66ed0a6c4c8f599402ea9fa",
"content_fingerprint": "6bd8bf2556e986fde5847f5f4ca6fc272a1e2cb5b253080fd69e9ce4ff6e8e0f",
"created_by_user_id": 1,
"reviewed_by_user_id": null,
"created_at": "2026-11-06 22:11:23"
},
"definition": {
"settings": {
"languages": [
"hr",
"en"
],
"enabled_languages": [
"hr",
"en"
],
"timezone": "Europe/Zagreb",
"opens_at": null,
"closes_at": null,
"audience_mode": "public",
"privacy_mode": "anonymous",
"results_visibility": "private",
"public_cookie_days": 30,
"results_timing": "during",
"results_audience": "public",
"admission": [],
"invitees_required": false,
"show_question_codes": false,
"show_choice_codes": false
},
"pages": [
{
"uuid": "10000000-0000-4000-8000-000000000001",
"require_complete": true,
"blocks": [
{
"uuid": "10000000-0000-4000-8000-000000000002",
"kind": "html"
},
{
"uuid": "10000000-0000-4000-8000-000000000003",
"kind": "question",
"question": {
"uuid": "10000000-0000-4000-8000-000000000004",
"type": "radio",
"alias": "EASE",
"required": true,
"settings": [],
"choices": [
{
"uuid": "10000000-0000-4000-8000-000000000005",
"code": "1",
"kind": "regular"
},
{
"uuid": "10000000-0000-4000-8000-000000000006",
"code": "2",
"kind": "regular"
},
{
"uuid": "10000000-0000-4000-8000-000000000007",
"code": "3",
"kind": "regular"
}
]
}
},
{
"uuid": "10000000-0000-4000-8000-000000000008",
"kind": "question",
"question": {
"uuid": "10000000-0000-4000-8000-000000000009",
"type": "rating",
"alias": "RATING",
"required": true,
"settings": {
"min": 1,
"max": 5
},
"choices": []
}
},
{
"uuid": "10000000-0000-4000-8000-000000000010",
"kind": "question",
"question": {
"uuid": "10000000-0000-4000-8000-000000000011",
"type": "textarea",
"alias": "COMMENT",
"required": false,
"settings": {
"max_length": 1000
},
"choices": []
}
}
]
}
],
"texts": {
"hr": {
"eaf6b9bc-2459-4849-8102-7343e047a09f": {
"title": "Povratna informacija o radionici"
},
"10000000-0000-4000-8000-000000000001": {
"title": "Vaše iskustvo"
},
"10000000-0000-4000-8000-000000000002": {
"html": "<h2>Vaše mišljenje nam je važno</h2><p>Ova je ogledna anketa izrađena putem API-ja i objavljena kroz redovni tijek pregleda. Javna je i anonimna. Ne unosite osobne podatke.</p>"
},
"10000000-0000-4000-8000-000000000003": {
"html": ""
},
"10000000-0000-4000-8000-000000000004": {
"text": "Koliko vam je jednostavno koristiti ankete?",
"help_html": ""
},
"10000000-0000-4000-8000-000000000005": {
"label": "Jednostavno"
},
"10000000-0000-4000-8000-000000000006": {
"label": "Uglavnom jednostavno"
},
"10000000-0000-4000-8000-000000000007": {
"label": "Treba poboljšati"
},
"10000000-0000-4000-8000-000000000008": {
"html": ""
},
"10000000-0000-4000-8000-000000000009": {
"text": "Vaša ukupna ocjena",
"help_html": ""
},
"10000000-0000-4000-8000-000000000010": {
"html": ""
},
"10000000-0000-4000-8000-000000000011": {
"text": "Što biste poboljšali?",
"help_html": ""
}
},
"en": {
"eaf6b9bc-2459-4849-8102-7343e047a09f": {
"title": "Workshop feedback"
},
"10000000-0000-4000-8000-000000000001": {
"title": "Your experience"
},
"10000000-0000-4000-8000-000000000002": {
"html": "<h2>Your feedback matters</h2><p>This example survey was created through the API and published through the normal review workflow. It is public and anonymous. Please enter no personal information.</p>"
},
"10000000-0000-4000-8000-000000000003": {
"html": ""
},
"10000000-0000-4000-8000-000000000004": {
"text": "How easy is it to use surveys?",
"help_html": ""
},
"10000000-0000-4000-8000-000000000005": {
"label": "Easy"
},
"10000000-0000-4000-8000-000000000006": {
"label": "Mostly easy"
},
"10000000-0000-4000-8000-000000000007": {
"label": "Needs improvement"
},
"10000000-0000-4000-8000-000000000008": {
"html": ""
},
"10000000-0000-4000-8000-000000000009": {
"text": "Your overall rating",
"help_html": ""
},
"10000000-0000-4000-8000-000000000010": {
"html": ""
},
"10000000-0000-4000-8000-000000000011": {
"text": "What would you improve?",
"help_html": ""
}
}
},
"rules": []
},
"rights": {
"manage": true,
"publish": true,
"preview": true,
"delete": true
},
"versions": [
{
"uuid": "f7134760-fb72-46be-8753-37e4fc658f0f",
"survey_uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"revision_number": 1,
"state": "draft",
"title": "Povratna informacija o radionici",
"structure_fingerprint": "416e9b4b28f5f95ec65ba960d5a43f223fa6c228c66ed0a6c4c8f599402ea9fa",
"content_fingerprint": "6bd8bf2556e986fde5847f5f4ca6fc272a1e2cb5b253080fd69e9ce4ff6e8e0f",
"created_by_user_id": 1,
"reviewed_by_user_id": null,
"created_at": "2026-11-06 22:11:23"
}
]
},
"meta": {
"request_id": "f8c16b4a617b7954567f8043c5fc66d9"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403, 409. Statusbedeutungen und Problemreaktionen finden Sie unter gemeinsame Regeln.
POST /api/v1/surveys/{survey}/exports
Zweck: Erstellt einen begrenzten privaten Manager-Export.
Berechtigung: surveys:export. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: from, include_identity, lang, mode, to. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"mode": "aggregate",
"lang": "hr"
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/exports"
Tatsächliche Antwort: HTTP 201.
{
"data": {
"token": "[REDACTED]",
"expires": 1794089656
},
"meta": {
"request_id": "87f7f878891a1a9eeb6030c016dcfdb1"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
GET /api/v1/surveys/{survey}/exports/{token}
Zweck: Beim Download werden der Berechtigungsumfang des Schlüssels, der aktuelle Besitzer und die aktuellen Verwaltungsrechte erneut überprüft.
Berechtigung: surveys:export. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey, token. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Körper: keine zusätzlichen Eingabefelder; Folgen Sie dem Beispiel.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--dump-header response-headers.txt \
--output response.csv \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/exports/[REDACTED]"
Tatsächliche Antwort: HTTP 200.
content-type: text/csv; charset=UTF-8
content-disposition: attachment; filename="survey-results.csv"
cache-control: private, no-store
Die Datei wird als response.* gespeichert. Der überprüfte Inhalt hat 564 Bytes; Dekodieren Sie es nicht als JSON.
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
GET /api/v1/surveys/{survey}/responses
Zweck: Ein Ergebnis-Scope allein kann keine Rohantworten lesen.
Berechtigung: surveys:results. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: from, to, lang, page, per_page.
Körper: keine zusätzlichen Eingabefelder; Folgen Sie dem Beispiel.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/responses?lang=hr&page=1&per_page=10"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"items": [],
"total": 0,
"page": 1,
"pages": 1,
"per_page": 10,
"language": "hr",
"filters": {
"from": "",
"to": ""
}
},
"meta": {
"request_id": "e6f818a6c72e45d14e81cc9bc24fc6ed"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
GET /api/v1/surveys/{survey}/results
Zweck: API-Schlüssel können die externe Teilnehmersitzung eines Browsers nicht ausleihen.
Berechtigung: surveys:results. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: from, to, lang, page, per_page.
Körper: keine zusätzlichen Eingabefelder; Folgen Sie dem Beispiel.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/results?lang=hr&page=1&per_page=10"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"title": "Povratna informacija o radionici",
"language": "hr",
"languages": [
"hr",
"en"
],
"manager": true,
"privacy": "anonymous",
"total": 0,
"questions": [
{
"question": "Koliko vam je jednostavno koristiti ankete?",
"type": "radio",
"code": "",
"answered": 0,
"unanswered": 0,
"suppressed": false,
"series": [
{
"label": "",
"base": 0,
"cells": [
{
"label": "Jednostavno",
"count": 0,
"percent": 0
},
{
"label": "Uglavnom jednostavno",
"count": 0,
"percent": 0
},
{
"label": "Treba poboljšati",
"count": 0,
"percent": 0
}
]
}
],
"statistics": []
},
{
"question": "Vaša ukupna ocjena",
"type": "rating",
"code": "",
"answered": 0,
"unanswered": 0,
"suppressed": false,
"series": [
{
"label": "",
"base": 0,
"cells": [
{
"label": "1",
"count": 0,
"percent": 0
},
{
"label": "2",
"count": 0,
"percent": 0
},
{
"label": "3",
"count": 0,
"percent": 0
},
{
"label": "4",
"count": 0,
"percent": 0
},
{
"label": "5",
"count": 0,
"percent": 0
}
]
}
],
"statistics": {
"average": null,
"minimum": null,
"maximum": null
}
},
{
"question": "Što biste poboljšali?",
"type": "textarea",
"code": "",
"answered": 0,
"unanswered": 0,
"suppressed": false,
"series": [],
"statistics": []
}
],
"question_total": 3,
"page": 1,
"pages": 1,
"per_page": 10,
"filters": {
"from": "",
"to": ""
},
"threshold": 5
},
"meta": {
"request_id": "8e39299f410e693376022ae9c92e2a70"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/submit-review
Zweck: Sendet den aktuellen Entwurf zur Überprüfung.
Berechtigung: surveys:write. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 1,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/submit-review"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"operation": "submit-review"
},
"meta": {
"request_id": "41d72f79366e63c5610b2486892f4891"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/return-review
Zweck: Ein Herausgeber gibt den Entwurf zur Änderung zurück.
Berechtigung: surveys:publish. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 2,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/return-review"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"operation": "return-review"
},
"meta": {
"request_id": "b3fb60f7050f1cb8f9472bf68a0a9f0e"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/publish
Zweck: Veröffentlicht die überprüfte Revision.
Berechtigung: surveys:publish. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 6,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/publish"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"operation": "publish"
},
"meta": {
"request_id": "46280486ab83f18775aae1fdc1213711"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403, 409. Statusbedeutungen und Problemreaktionen finden Sie unter gemeinsame Regeln.
POST /api/v1/surveys/{survey}/close
Zweck: Schließt die Antwortsammlung.
Berechtigung: surveys:publish. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 7,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/close"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"operation": "close"
},
"meta": {
"request_id": "4ab5027fe4df4091de6037b5d13f44f4"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/archive
Zweck: Archiviert die Umfrage.
Berechtigung: surveys:publish. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 8,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/archive"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"operation": "archive"
},
"meta": {
"request_id": "935368dcefbb1bbcdc6dfd73963ccddf"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/withdraw
Zweck: Zieht den Entwurf zur Bearbeitung aus der Prüfung zurück.
Berechtigung: surveys:write. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 4,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/withdraw"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"operation": "withdraw"
},
"meta": {
"request_id": "82758373ec56db91127f56291ff31322"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/copy
Zweck: Erstellt einen neuen Entwurf ohne vorherige Antworten.
Berechtigung: surveys:write. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 1,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true,
"title": "API kopija za provjeru nacrta"
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/copy"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "26664ec4-13ce-45eb-82d1-fdac825f219b"
},
"meta": {
"request_id": "37630bd30d1bff33f103c3397f8e3126"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/delete
Zweck: Löscht die Umfrage wiederherstellbar und behält die Antworten bei.
Berechtigung: surveys:write. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 9,
"revision": "f7134760-fb72-46be-8753-37e4fc658f0f",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/eaf6b9bc-2459-4849-8102-7343e047a09f/delete"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "eaf6b9bc-2459-4849-8102-7343e047a09f",
"operation": "delete",
"deleted": true
},
"meta": {
"request_id": "f79755796c0cedf2a3ada17e594dbce7"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/discard-draft
Zweck: Verwirft den Arbeitsentwurf gemäß den dokumentierten Workflow-Regeln.
Berechtigung: surveys:write. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 0,
"revision": "225cc989-f91a-4043-bea7-5d5f89eaf786",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/26664ec4-13ce-45eb-82d1-fdac825f219b/discard-draft"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "26664ec4-13ce-45eb-82d1-fdac825f219b",
"operation": "discard-draft",
"deleted": true
},
"meta": {
"request_id": "ce5fdb5a30f5cc49eecfbc0879e37c1c"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
POST /api/v1/surveys/{survey}/restore
Zweck: Ein Administrator stellt eine gelöschte Umfrage wieder her; die bisher veröffentlichte Sammlung bleibt geschlossen.
Berechtigung: surveys:publish. Aktuelle Bearbeitungs-, Veröffentlichungs- und Ergebnisberechtigungen für Umfragen/Arbeitsbereiche; Kein Identitätswechsel der Teilnehmer.
Pfad: survey. Übernehmen Sie die Werte aus der vorherigen Antwort. Eine Seiten-ID ist ihr Dokumentschlüssel; nodeId ist numerisch und ein UUID ist kein Slug.
Abfrageparameter: keine.
Textkörper / unterstützte Felder: confirmed, revision, title, version. Das folgende Beispiel verwendet verifizierte Werte; Bedingungen und Listenersetzungsregeln werden am Anfang des Kapitels beschrieben.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"version": 1,
"revision": "225cc989-f91a-4043-bea7-5d5f89eaf786",
"confirmed": true
}' \
"$BASE_URL/api/v1/surveys/26664ec4-13ce-45eb-82d1-fdac825f219b/restore"
Tatsächliche Antwort: HTTP 200.
{
"data": {
"uuid": "26664ec4-13ce-45eb-82d1-fdac825f219b",
"operation": "restore",
"deleted": false
},
"meta": {
"request_id": "09b6e5dc6d714041f074fde62f7183dd"
},
"links": []
}
Für diesen Vorgang überprüfte Fehler: 401, 403. Siehe gemeinsame Regeln für Statusbedeutungen und Problemreaktionen.
Commentaires
0Il n'y a pas encore de commentaires.
Vous devez vous connecter pour ajouter un commentaire.