{ "openapi": "3.0.1", "info": { "title": "InSurvey API", "description": "", "version": "v1" }, "paths": { "/activity": { "get": { "tags": [ "Activity" ], "parameters": [ { "name": "formId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityPagedList" } } } } } } }, "/activity/{id}": { "get": { "tags": [ "Activity" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } } }, "/activity/{formId}/{activityId}": { "get": { "tags": [ "Activity" ], "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } }, "put": { "tags": [ "Activity" ], "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } }, "delete": { "tags": [ "Activity" ], "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/activity/{formId}": { "post": { "tags": [ "Activity" ], "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } } }, "/answer/{responderSessionGuid}": { "get": { "tags": [ "Answer" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "segmentGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentedAnswers" } } } } } } } }, "/answer/{responderSessionGuid}/store": { "post": { "tags": [ "Answer" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableSegmentedAnswers" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableSegmentedAnswers" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableSegmentedAnswers" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableSegmentedAnswers" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerStorageResult" } } } } } } } }, "/answerValidator/{formId}/{versionId}/list": { "get": { "tags": [ "AnswerValidator" ], "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerValidatorPagedList" } } } } } } }, "/answerValidator/{contentId}/list": { "get": { "tags": [ "AnswerValidator" ], "parameters": [ { "name": "contentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerValidatorPagedList" } } } } } } }, "/answerValidator/{contentId}/hierarchical": { "get": { "tags": [ "AnswerValidator" ], "parameters": [ { "name": "contentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerValidatorPagedList" } } } } } } }, "/answerValidator/{id}": { "get": { "tags": [ "AnswerValidator" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerValidator" } } } } } }, "put": { "tags": [ "AnswerValidator" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableAnswerValidator" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableAnswerValidator" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableAnswerValidator" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableAnswerValidator" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerValidator" } } } } } }, "delete": { "tags": [ "AnswerValidator" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/answerValidator": { "post": { "tags": [ "AnswerValidator" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableAnswerValidator" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableAnswerValidator" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableAnswerValidator" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableAnswerValidator" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerValidator" } } } } } } }, "/auth/login": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewServiceServiceUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewServiceServiceUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewServiceServiceUserLogin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewServiceServiceUserLogin" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatedUser" } } } } } } }, "/auth/login/otp": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewUserOtpLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewUserOtpLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewUserOtpLogin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewUserOtpLogin" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpResponse" } } } } } } }, "/auth/login/otp/{userId}/verify": { "post": { "tags": [ "Auth" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserOtpVerification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserOtpVerification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserOtpVerification" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserOtpVerification" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpVerificationResponse" } } } } } } }, "/auth/login/responderApp": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewAppUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewAppUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewAppUserLogin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewAppUserLogin" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatedUser" } } } } } } }, "/auth/authenticatedUser": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatedUser" } } } } } } }, "/auth/logout": { "post": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/bi/powerBi/{fieldPeriodId}/definition": { "get": { "tags": [ "Bi" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IBiDefinition" } } } } } } }, "/bi/powerBi/{fieldPeriodId}/responders": { "get": { "tags": [ "Bi" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includePersonalData", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IBiResponderPagedList" } } } } } } }, "/bi/powerBi/{fieldPeriodId}/responders/export": { "post": { "tags": [ "Bi" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includePersonalData", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BiResponderExportStarted" } } } } } } }, "/chat/message": { "post": { "tags": [ "Chat" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatMessageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatMessageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageResponse" } } } } } } }, "/chat/conversations": { "get": { "tags": [ "Chat" ], "parameters": [ { "name": "scope", "in": "query", "schema": { "$ref": "#/components/schemas/ChatScope" } }, { "name": "focusEntityId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatConversationSummaryPagedList" } } } } } } }, "/chat/conversations/{identifier}": { "get": { "tags": [ "Chat" ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatConversationDetail" } } } } } }, "delete": { "tags": [ "Chat" ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/colorPalette": { "get": { "tags": [ "ColorPalette" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "includePermissionForReportId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorPalettePagedList" } } } } } }, "post": { "tags": [ "ColorPalette" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewColorPalette" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewColorPalette" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewColorPalette" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewColorPalette" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorPalette" } } } } } } }, "/colorPalette/{id}": { "get": { "tags": [ "ColorPalette" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorPalette" } } } } } }, "put": { "tags": [ "ColorPalette" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateColorPalette" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateColorPalette" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateColorPalette" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateColorPalette" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorPalette" } } } } } }, "delete": { "tags": [ "ColorPalette" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/content/inputQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableInputQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableInputQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableInputQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableInputQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputQuestion" } } } } } } }, "/content/fileQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableFileQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableFileQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableFileQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableFileQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuestion" } } } } } } }, "/content/canvasQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvasQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableCanvasQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableCanvasQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableCanvasQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableCanvasQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvasQuestion" } } } } } } }, "/content/mapQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableMapQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableMapQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableMapQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableMapQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapQuestion" } } } } } } }, "/content/textMultipleFieldsQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMultipleFieldsQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMultipleFieldsQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMultipleFieldsQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMultipleFieldsQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMultipleFieldsQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMultipleFieldsQuestion" } } } } } } }, "/content/optionQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionQuestion" } } } } } } }, "/content/scaleQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScaleQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableScaleQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableScaleQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableScaleQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableScaleQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScaleQuestion" } } } } } } }, "/content/optionMatrixQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionMatrixQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionMatrixQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionMatrixQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionMatrixQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableOptionMatrixQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionMatrixQuestion" } } } } } } }, "/content/textMatrixQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMatrixQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMatrixQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMatrixQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMatrixQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableTextMatrixQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMatrixQuestion" } } } } } } }, "/content/rankingQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RankingQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableRankingQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableRankingQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableRankingQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableRankingQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RankingQuestion" } } } } } } }, "/content/text/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Text" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableText" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Text" } } } } } } }, "/content/area/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Area" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableArea" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableArea" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableArea" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableArea" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Area" } } } } } } }, "/content/area/{id}/structure": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstanceStructure" } } } } } } }, "/content/areaRepeater/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaRepeater" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaRepeater" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaRepeater" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaRepeater" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaRepeater" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaRepeater" } } } } } } }, "/content/areaSegmenter/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaSegmenter" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaSegmenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaSegmenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaSegmenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableAreaSegmenter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaSegmenter" } } } } } } }, "/content/dataSetTypeAheadQuestion/{id}": { "get": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSetTypeAheadQuestion" } } } } } }, "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableDataSetTypeAheadQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableDataSetTypeAheadQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableDataSetTypeAheadQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableDataSetTypeAheadQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSetTypeAheadQuestion" } } } } } } }, "/content/inputQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableInputQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableInputQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableInputQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableInputQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputQuestion" } } } } } } }, "/content/fileQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableFileQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableFileQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableFileQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableFileQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuestion" } } } } } } }, "/content/canvasQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableCanvasQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableCanvasQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableCanvasQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableCanvasQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvasQuestion" } } } } } } }, "/content/mapQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableMapQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableMapQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableMapQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableMapQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapQuestion" } } } } } } }, "/content/textMultipleFieldsQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableTextMultipleFieldsQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableTextMultipleFieldsQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableTextMultipleFieldsQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableTextMultipleFieldsQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMultipleFieldsQuestion" } } } } } } }, "/content/optionQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableOptionQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableOptionQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableOptionQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableOptionQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionQuestion" } } } } } } }, "/content/scaleQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableScaleQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableScaleQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableScaleQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableScaleQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScaleQuestion" } } } } } } }, "/content/optionMatrixQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableOptionMatrixQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableOptionMatrixQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableOptionMatrixQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableOptionMatrixQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionMatrixQuestion" } } } } } } }, "/content/textMatrixQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableTextMatrixQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableTextMatrixQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableTextMatrixQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableTextMatrixQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMatrixQuestion" } } } } } } }, "/content/rankingQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableRankingQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableRankingQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableRankingQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableRankingQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RankingQuestion" } } } } } } }, "/content/dataSetTypeAheadQuestion": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableDataSetTypeAheadQuestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableDataSetTypeAheadQuestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableDataSetTypeAheadQuestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableDataSetTypeAheadQuestion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSetTypeAheadQuestion" } } } } } } }, "/content/text": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableText" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Text" } } } } } } }, "/content/area": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableArea" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableArea" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableArea" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableArea" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Area" } } } } } } }, "/content/areaRepeater": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableAreaRepeater" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableAreaRepeater" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableAreaRepeater" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableAreaRepeater" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaRepeater" } } } } } } }, "/content/areaSegmenter": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableAreaSegmenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableAreaSegmenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableAreaSegmenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableAreaSegmenter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaSegmenter" } } } } } } }, "/content/{id}": { "delete": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/content/{id}/{culture}": { "delete": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "culture", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/content/area/{id}/instance/{contentId}": { "post": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstanceReference" } } } } } } }, "/content/area/{id}/instance/{contentInstanceId}": { "delete": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contentInstanceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/content/area/{id}/sortOrder": { "put": { "tags": [ "Content" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } } } }, "responses": { "200": { "description": "OK" } } } }, "/content/move/instance": { "post": { "tags": [ "Content" ], "parameters": [ { "name": "ignoreMultipleContentInstanceException", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveContentInstanceInstructions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MoveContentInstanceInstructions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveContentInstanceInstructions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveContentInstanceInstructions" } } } }, "responses": { "200": { "description": "OK" } } } }, "/content/{contextContentId}/clone/{id}": { "post": { "tags": [ "Content" ], "parameters": [ { "name": "contextContentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contentInstanceUri", "in": "query", "schema": { "type": "string", "format": "uri" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IClonedContentReceipt" } } } } } } }, "/contentBucket": { "get": { "tags": [ "ContentBucket" ], "parameters": [ { "name": "scopeLevel", "in": "query", "schema": { "$ref": "#/components/schemas/ContentBucketScopeLevel" } }, { "name": "targetEntityId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentBucket" } } } } } }, "post": { "tags": [ "ContentBucket" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableScopedContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableScopedContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableScopedContent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableScopedContent" } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "ContentBucket" ], "parameters": [ { "name": "scopeLevel", "in": "query", "schema": { "$ref": "#/components/schemas/ContentBucketScopeLevel" } }, { "name": "targetEntityId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "contentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ignoreInstanceExistException", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/contentCondition/{contextEntityType}/{contextEntityId}": { "get": { "tags": [ "ContentCondition" ], "parameters": [ { "name": "contextEntityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ContentStructureContext" } }, { "name": "contextEntityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionFilterTargetConditionContext" } } } } } } } }, "/contentCondition/{id}": { "get": { "tags": [ "ContentCondition" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentCondition" } } } } } }, "delete": { "tags": [ "ContentCondition" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/contentCondition": { "post": { "tags": [ "ContentCondition" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableContentCondition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableContentCondition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableContentCondition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableContentCondition" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentCondition" } } } } } } }, "/contentExport/{sourceEntityType}/{sourceEntityId}": { "post": { "tags": [ "ContentExport" ], "parameters": [ { "name": "sourceEntityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ContentStructureContext" } }, { "name": "sourceEntityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentExport" } } } } } } }, "/contentExport/{sourceEntityType}/{sourceEntityId}/fileBucket": { "post": { "tags": [ "ContentExport" ], "parameters": [ { "name": "sourceEntityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ContentStructureContext" } }, { "name": "sourceEntityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentExportSettings" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileWithPublicUrl" } } } } } } }, "/contentImport/{formId}/{formVersionId}": { "post": { "tags": [ "ContentImport" ], "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "formVersionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "targetContentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentImport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentImport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentImport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentImport" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentImportResult" } } } } } } }, "/contentImport/{formId}/{formVersionId}/fileBucket/{fileName}": { "post": { "tags": [ "ContentImport" ], "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "formVersionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "targetContentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentImportResult" } } } } } } }, "/costCenter": { "get": { "tags": [ "CostCenter" ], "parameters": [ { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includePermissionForFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostCenterIPagedList" } } } } } }, "post": { "tags": [ "CostCenter" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewCostCenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewCostCenter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostCenter" } } } } } } }, "/costCenter/{id}": { "get": { "tags": [ "CostCenter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostCenterWithBalance" } } } } } }, "put": { "tags": [ "CostCenter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCostCenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCostCenter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostCenter" } } } } } }, "delete": { "tags": [ "CostCenter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/costCenter/{id}/balance": { "get": { "tags": [ "CostCenter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICostCenterBalance" } } } } } } }, "/costCenter/{id}/transactions": { "post": { "tags": [ "CostCenter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CostCenterTransactionFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CostCenterTransactionFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CostCenterTransactionFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CostCenterTransactionFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostCenterTransactionIPagedList" } } } } } } }, "/dataSetProvider": { "get": { "tags": [ "DataSetProvider" ], "parameters": [ { "name": "capability", "in": "query", "schema": { "$ref": "#/components/schemas/DataSetProviderCapability" } }, { "name": "includePermissionForContentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includePermissionForEventId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataSetProviderDefinition" } } } } } } } }, "/dataSetProvider/{id}/schema": { "get": { "tags": [ "DataSetProvider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IDataSetProviderConfigurationSchemaProperty" } } } } } } } }, "/entityPermission/{targetType}/{targetId}/currentUser": { "get": { "tags": [ "EntityPermission" ], "parameters": [ { "name": "targetType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityPermissionTargetType" } }, { "name": "targetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } } } } }, "/entityPermission/{targetType}/{targetId}": { "get": { "tags": [ "EntityPermission" ], "parameters": [ { "name": "targetType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityPermissionTargetType" } }, { "name": "targetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "sourceType", "in": "query", "schema": { "$ref": "#/components/schemas/EntityPermissionSourceType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionPagedList" } } } } } } }, "/entityPermission/{targetType}/{targetId}/all": { "get": { "tags": [ "EntityPermission" ], "parameters": [ { "name": "targetType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityPermissionTargetType" } }, { "name": "targetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "sourceType", "in": "query", "schema": { "$ref": "#/components/schemas/EntityPermissionSourceType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionPagedList" } } } } } } }, "/entityPermission": { "post": { "tags": [ "EntityPermission" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewEntityPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewEntityPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewEntityPermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewEntityPermission" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPermission" } } } } } } }, "/entityPermission/{id}": { "put": { "tags": [ "EntityPermission" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditableEntityPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditableEntityPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditableEntityPermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditableEntityPermission" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPermission" } } } } } }, "delete": { "tags": [ "EntityPermission" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/entityPermission/{id}/owner": { "put": { "tags": [ "EntityPermission" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPermission" } } } } } } }, "/entityPermission/cloneUserPermissions": { "post": { "tags": [ "EntityPermission" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CloneUserPermissions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloneUserPermissions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneUserPermissions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloneUserPermissions" } } } }, "responses": { "200": { "description": "OK" } } } }, "/escobar/generateRandomAnswers/{activityId}/{fieldPeriodId}/{formId}/{formVersionId}/{responderCount}": { "get": { "tags": [ "Escobar" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "formVersionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "responderCount", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dropPreviousAnswers", "in": "query", "schema": { "type": "boolean" } }, { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/escobar/exportResponderImportFile": { "get": { "tags": [ "Escobar" ], "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string" } }, { "name": "rowCount", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1024 } }, { "name": "uniqueEmail", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/escobar/addTemporaryResponders/{registryId}": { "get": { "tags": [ "Escobar" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "key", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1024 } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/escobar/convertResponders": { "get": { "tags": [ "Escobar" ], "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/escobar/notifyEveryone": { "get": { "tags": [ "Escobar" ], "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/escobar/notifyAllAdministrators": { "get": { "tags": [ "Escobar" ], "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/escobar/notifyAdministrator/{id}": { "get": { "tags": [ "Escobar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/event/{fieldPeriodId}": { "get": { "tags": [ "Event" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "minimum": 0, "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPagedList" } } } } } }, "post": { "tags": [ "Event" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } } } } }, "/event/{fieldPeriodId}/{id}": { "get": { "tags": [ "Event" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "minimum": 0, "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "minimum": 0, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } } } }, "put": { "tags": [ "Event" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "minimum": 0, "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableEvent" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } } } }, "delete": { "tags": [ "Event" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "minimum": 0, "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "minimum": 0, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/fieldperiod/{activityId}": { "get": { "tags": [ "FieldPeriod" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodPagedList" } } } } } }, "post": { "tags": [ "FieldPeriod" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableFieldPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableFieldPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableFieldPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableFieldPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriod" } } } } } } }, "/fieldperiod/registry/{responderRegistryId}": { "get": { "tags": [ "FieldPeriod" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodPagedList" } } } } } } }, "/fieldperiod/{activityId}/{fieldPeriodId}": { "get": { "tags": [ "FieldPeriod" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriod" } } } } } }, "put": { "tags": [ "FieldPeriod" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriod" } } } } } }, "delete": { "tags": [ "FieldPeriod" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/fieldperiod/{activityId}/{fieldPeriodId}/statistics": { "post": { "tags": [ "FieldPeriod" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetFieldPeriodStatisticsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFieldPeriodStatisticsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFieldPeriodStatisticsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetFieldPeriodStatisticsRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFieldPeriodStatistics" } } } } } } }, "/fieldPeriodMessage/{fieldPeriodId}/{messageId}": { "get": { "tags": [ "FieldPeriodMessage" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessage" } } } } } }, "put": { "tags": [ "FieldPeriodMessage" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriodMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriodMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriodMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableFieldPeriodMessage" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessage" } } } } } }, "delete": { "tags": [ "FieldPeriodMessage" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/fieldPeriodMessage/{fieldPeriodId}": { "get": { "tags": [ "FieldPeriodMessage" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "distributionType", "in": "query", "schema": { "$ref": "#/components/schemas/ResponderDistributionType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessagePagedList" } } } } } }, "post": { "tags": [ "FieldPeriodMessage" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessage" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessage" } } } } } } }, "/fieldPeriodMessage/{fieldPeriodId}/{messageId}/{culture}": { "delete": { "tags": [ "FieldPeriodMessage" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "culture", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/fieldPeriodMessage/smsPartCountForecast": { "post": { "tags": [ "FieldPeriodMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SmsPartCountForecastRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmsPartCountForecastRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsPartCountForecastRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SmsPartCountForecastRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsPartCountForecastResponse" } } } } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/{fieldPeriodMessageId}/{cultureAlias}": { "post": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessageDistribution" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessageDistribution" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessageDistribution" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodMessageDistribution" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDeliveryStatus" } } } } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/scheduled/{id}": { "get": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionWithQuery" } } } } } }, "delete": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/scheduled": { "get": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionPagedList" } } } } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/scheduled/{fieldPeriodMessageId}/{cultureAlias}": { "post": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageStatus" } } } } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/{fieldPeriodMessageId}/{cultureAlias}/schedule": { "post": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageStatus" } } } } }, "deprecated": true } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/batch": { "get": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessageBatchPagedList" } } } } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/batch/{batchId}/message": { "get": { "tags": [ "FieldPeriodMessageDistribution" ], "operationId": "GetFieldPeriodMessagesAsync", "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "301": { "description": "Moved Permanently" }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagePagedList" } } } } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/batch/{batchId}/event": { "get": { "tags": [ "FieldPeriodMessageDistribution" ], "operationId": "GetMessageBatchEventsAsync", "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "responderGuids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "301": { "description": "Moved Permanently" }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDistributionEventPagedList" } } } } } } }, "/fieldPeriodMessageDistribution/{fieldPeriodId}/forecast/{fieldPeriodMessageId}": { "post": { "tags": [ "FieldPeriodMessageDistribution" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodMessageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "excludeOptedOut", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessageDistributionForecast" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessageDistributionForecast" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessageDistributionForecast" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FieldPeriodMessageDistributionForecast" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISendOutForecast" } } } } } } }, "/fileBucket/{fileStorageType}": { "post": { "tags": [ "FileBucket" ], "parameters": [ { "name": "fileStorageType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/FileStorageType" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "encoding": { "files": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileWithPublicUrl" } } } } } } } }, "/fileBucket/{fileStorageType}/base64": { "post": { "tags": [ "FileBucket" ], "parameters": [ { "name": "fileStorageType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/FileStorageType" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewBase64FileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewBase64FileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewBase64FileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewBase64FileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileWithPublicUrl" } } } } } } }, "/fileBucket/{fileName}": { "get": { "tags": [ "FileBucket" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "inline", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "FileBucket" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/fileBucket/{fileName}/base64": { "get": { "tags": [ "FileBucket" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base64File" } } } } } } }, "/fileBucket/{fileName}/metadata": { "get": { "tags": [ "FileBucket" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File" } } } } } } }, "/filter/{id}": { "get": { "tags": [ "Filter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } } } } }, "delete": { "tags": [ "Filter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/filter/{guid}": { "get": { "tags": [ "Filter" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } } } } }, "delete": { "tags": [ "Filter" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/filter/store/contentFilterEntry": { "post": { "tags": [ "Filter" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "guid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewContentFilterEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewContentFilterEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewContentFilterEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewContentFilterEntry" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } } } } } }, "/filter/store/reportItemFilterEntries": { "post": { "tags": [ "Filter" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "guid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewReportItemFilterEntries" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewReportItemFilterEntries" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewReportItemFilterEntries" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewReportItemFilterEntries" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } } } } } }, "/filter/{id}/entry": { "delete": { "tags": [ "Filter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "entryGroupIdentifier", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/filter/{id}/entry/{entryIdentifierGuid}": { "delete": { "tags": [ "Filter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "entryIdentifierGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/filter/{guid}/entry": { "delete": { "tags": [ "Filter" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entryGroupIdentifier", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/filter/{guid}/entry/{entryIdentifierGuid}": { "delete": { "tags": [ "Filter" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entryIdentifierGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/form": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "listingType", "in": "query", "schema": { "$ref": "#/components/schemas/FormListingType" } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/FormOrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "groupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TinyFormPagedList" } } } } } }, "post": { "tags": [ "Form" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableForm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableForm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableForm" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableForm" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } } } } }, "/form/many": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TinyForm" } } } } } } } }, "/form/{id}": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } } } }, "put": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableForm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableForm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableForm" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableForm" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } } } }, "delete": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/form/{id}/{versionId}": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } } } } }, "/form/{id}/{versionId}/statistics": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormVersionStatistics" } } } } } } }, "/form/{id}/{versionId}/structure": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstanceStructure" } } } } } } }, "/form/{versionId}/structure": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstanceStructure" } } } } } } }, "/form/{id}/{versionId}/{cultureAlias}": { "post": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/form/{id}/{versionId}/{cultureAlias}/preferred": { "put": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/form/{id}/{versionId}/instance/{contentId}": { "post": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstanceReference" } } } } } } }, "/form/{id}/{versionId}/instance/{contentInstanceId}": { "delete": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contentInstanceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/form/{id}/{versionId}/sortOrder": { "put": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentInstancesSortOrder" } } } }, "responses": { "200": { "description": "OK" } } } }, "/form/{id}/{versionId}/clone/{contentId}": { "post": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contentInstanceUri", "in": "query", "schema": { "type": "string", "format": "uri" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IClonedContentReceipt" } } } } } } }, "/form/{id}/{versionId}/export/{fileType}": { "get": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fileType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/FormExportType" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } } } } }, "/form/{id}/copy": { "post": { "tags": [ "Form" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FormCopy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FormCopy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FormCopy" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FormCopy" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } } } } }, "/formTemplate": { "get": { "tags": [ "FormTemplate" ], "parameters": [ { "name": "includePermissionForFormId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "uiType", "in": "query", "schema": { "$ref": "#/components/schemas/ResponderUiType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatePagedList" } } } } } }, "post": { "tags": [ "FormTemplate" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableFormTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableFormTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableFormTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableFormTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplate" } } } } } } }, "/formTemplate/{id}": { "get": { "tags": [ "FormTemplate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplate" } } } } } }, "put": { "tags": [ "FormTemplate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableFormTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableFormTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableFormTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableFormTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplate" } } } } } }, "delete": { "tags": [ "FormTemplate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/formTemplate/{templateIdentifier}/template/css": { "get": { "tags": [ "FormTemplate" ], "operationId": "FormUiTemplateCSS", "parameters": [ { "name": "templateIdentifier", "in": "path", "required": true, "schema": { "pattern": "[a-zA-Z0-9]+", "type": "string" } }, { "name": "wrapWithTemplateCssClass", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } } } }, "/generator/qr": { "get": { "tags": [ "Generator" ], "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/group/{entityType}/hierarchy": { "get": { "tags": [ "Group" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityGroupType" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IEntityGroupWithRelationIHierarchyNode" } } } } } } } }, "/group/{entityType}": { "post": { "tags": [ "Group" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityGroupType" } }, { "name": "inheritPermissionsFromEntityGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableEntityGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableEntityGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableEntityGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableEntityGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IEntityGroup" } } } } } } }, "/group/{entityType}/{id}": { "put": { "tags": [ "Group" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityGroupType" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableEntityGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableEntityGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableEntityGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableEntityGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IEntityGroup" } } } } } }, "delete": { "tags": [ "Group" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityGroupType" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/group/{entityType}/{id}/{entityId}": { "post": { "tags": [ "Group" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityGroupType" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Group" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityGroupType" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/group/{entityType}/{id}/{fromId}/{entityId}": { "put": { "tags": [ "Group" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityGroupType" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fromId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/guid": { "get": { "tags": [ "Guid" ], "parameters": [ { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } } }, "/hello": { "get": { "tags": [ "Hello" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hello" } } } } } } }, "/I18N/cultures": { "get": { "tags": [ "I18N" ], "parameters": [ { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Culture" } } } } } } } }, "/I18N/countries": { "get": { "tags": [ "I18N" ], "parameters": [ { "name": "requirePinFormat", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } } }, "/maintenance/reindex/{fieldPeriodId}": { "post": { "tags": [ "Maintenance" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncReindexResponseNodeResponse" } } } } } } }, "/maintenance/inMemoryCache/keys": { "get": { "tags": [ "Maintenance" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableNodeResponse" } } } } } } }, "/maintenance/inMemoryCache/status": { "get": { "tags": [ "Maintenance" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryCacheStatusNodeResponse" } } } } } } }, "/maintenance/inMemoryCache/clear": { "delete": { "tags": [ "Maintenance" ], "parameters": [ { "name": "distributeInvalidation", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryCacheInvalidationResponseNodeResponse" } } } } } } }, "/maintenance/inMemoryCache/invalidationLog": { "get": { "tags": [ "Maintenance" ], "parameters": [ { "name": "beforeUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1024 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidationLogResponseNodeResponse" } } } } } }, "delete": { "tags": [ "Maintenance" ], "parameters": [ { "name": "beforeUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidationLogClearedResponseNodeResponse" } } } } } } }, "/maintenance/costCenter/{id}/deposit": { "post": { "tags": [ "Maintenance" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "amount", "in": "query", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositReceipt" } } } } } } }, "/maintenance/identifier/{identifier}/decode": { "get": { "tags": [ "Maintenance" ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIdentifierPatternDecodeResult" } } } } } } }, "/maintenance/rewriteResponderDataAnswers/{fieldPeriodId}": { "post": { "tags": [ "Maintenance" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RewriteResponderDataAnswersResponseNodeResponse" } } } } } } }, "/messy/incoming": { "post": { "tags": [ "Messy" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/news": { "get": { "tags": [ "News" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/INewsEntry" } } } } } } } }, "/priceList/sms": { "get": { "tags": [ "PriceList" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsPricePriceListWrapper" } } } } } } }, "/priceList/responderAuthentication": { "get": { "tags": [ "PriceList" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAuthenticationPricePriceListWrapper" } } } } } } }, "/report": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "permissionRestriction", "in": "query", "schema": { "$ref": "#/components/schemas/PermissionRestrictionFilter" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/ReportOrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "onlyRestrictedToActivityId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportExtendedPagedList" } } } } } }, "post": { "tags": [ "Report" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewReport" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } } } } }, "/report/many": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportExtended" } } } } } } } }, "/report/{id}": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } } } }, "put": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReport" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } } } }, "delete": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/report/{id}/reportDataSeries/sortOrder": { "put": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportDataSeriesSortOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSeriesSortOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDataSeriesSortOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportDataSeriesSortOrder" } } } }, "responses": { "200": { "description": "OK" } } } }, "/report/{id}/reportItems/sortOrder": { "put": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "parentReportItemId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportItemsSortOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportItemsSortOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportItemsSortOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportItemsSortOrder" } } } }, "responses": { "200": { "description": "OK" } } } }, "/report/{id}/{cultureAlias}": { "post": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/report/{id}/{cultureAlias}/preferred": { "put": { "tags": [ "Report" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportAnswer/{reportId}/{dataSeriesId}": { "get": { "tags": [ "ReportAnswer" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "dataSeriesId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportSegmentGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemCompositeStatistics" } } } } } } } }, "/reportAnswer/{reportId}": { "post": { "tags": [ "ReportAnswer" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportSegmentGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DataSeriesBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataSeriesBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataSeriesBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DataSeriesBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemCompositeStatistics" } } } } } } } }, "/reportAnswer/{reportId}/{dataSeriesId}/{reportItemId}/answerList": { "get": { "tags": [ "ReportAnswer" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportSegmentGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "dataSeriesId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportAnswerList" } } } } } } }, "/reportCrossTabulation/{reportId}": { "post": { "tags": [ "ReportCrossTabulation" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IReportEntityCreationReceipt" } } } } } } }, "/reportCrossTabulation/{reportId}/calculate": { "post": { "tags": [ "ReportCrossTabulation" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewCrossTabulationInstructions" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCrossTabulationCalculation" } } } } } } }, "/reportDataSeries/{reportId}": { "get": { "tags": [ "ReportDataSeries" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportSegmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSeriesPagedList" } } } } } }, "post": { "tags": [ "ReportDataSeries" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewDataSeries" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewDataSeries" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewDataSeries" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewDataSeries" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSeries" } } } } } } }, "/reportDataSeries/{reportId}/{id}": { "get": { "tags": [ "ReportDataSeries" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSeries" } } } } } }, "put": { "tags": [ "ReportDataSeries" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSeries" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSeries" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSeries" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSeries" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSeries" } } } } } }, "delete": { "tags": [ "ReportDataSeries" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportDataSeries/{reportId}/{id}/{cultureAlias}": { "delete": { "tags": [ "ReportDataSeries" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportDataSource/{reportId}": { "get": { "tags": [ "ReportDataSource" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSourcePagedList" } } } } } }, "post": { "tags": [ "ReportDataSource" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewDataSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewDataSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewDataSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewDataSource" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSource" } } } } } } }, "/reportDataSource/{reportId}/{id}": { "get": { "tags": [ "ReportDataSource" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSource" } } } } } }, "put": { "tags": [ "ReportDataSource" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSource" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDataSource" } } } } } }, "delete": { "tags": [ "ReportDataSource" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportExport/{reportId}/async": { "post": { "tags": [ "ReportExport" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DelayedReportExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayedReportExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayedReportExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DelayedReportExport" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAsyncBackgroundTask" } } } } } } }, "/reportExport/{reportId}": { "get": { "tags": [ "ReportExport" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportExport" } } } } } } } }, "/reportItem/{reportId}": { "get": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItemPagedList" } } } } } } }, "/reportItem/{reportId}/hierarchical": { "get": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemHierarchyNode" } } } } } } } }, "/reportItem/{reportId}/matrixStatistics": { "post": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateReportItemMatrixStatistics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportItemMatrixStatistics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateReportItemMatrixStatistics" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateReportItemMatrixStatistics" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/index": { "post": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateReportItemIndex" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportItemIndex" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateReportItemIndex" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateReportItemIndex" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/responseRate": { "post": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateReportItemResponseRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportItemResponseRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateReportItemResponseRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateReportItemResponseRate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/dataTable/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemDataTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemDataTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemDataTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemDataTable" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/rankedDataTable/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemRankedDataTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemRankedDataTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemRankedDataTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemRankedDataTable" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/nps/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNps" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNps" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNps" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNps" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/text/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemText" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/answerList/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemAnswerList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemAnswerList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemAnswerList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemAnswerList" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/numberStatistics/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNumberStatistics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNumberStatistics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNumberStatistics" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemNumberStatistics" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/matrixStatistics/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemMatrixStatistics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemMatrixStatistics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemMatrixStatistics" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemMatrixStatistics" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/index/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemIndex" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemIndex" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemIndex" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemIndex" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/responseRate/{id}": { "put": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemResponseRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemResponseRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemResponseRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReportItemResponseRate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportItem" } } } } } } }, "/reportItem/{reportId}/bulk/uiSettings": { "patch": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateReportItemInstructions" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateReportItemInstructions" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateReportItemInstructions" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateReportItemInstructions" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/reportItem/{reportId}/{id}/excludedDataSeries": { "patch": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchInstructions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatchInstructions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatchInstructions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchInstructions" } } } }, "responses": { "200": { "description": "OK" } } } }, "/reportItem/{reportId}/{id}": { "delete": { "tags": [ "ReportItem" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportSegment/{reportId}/hierarchy": { "get": { "tags": [ "ReportSegment" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IReportSegmentIHierarchyNode" } } } } } } } }, "/reportSegment/{reportId}": { "get": { "tags": [ "ReportSegment" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "parentReportSegmentId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IReportSegmentPagedList" } } } } } }, "post": { "tags": [ "ReportSegment" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewReportSegmentingInstructions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewReportSegmentingInstructions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewReportSegmentingInstructions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewReportSegmentingInstructions" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IReportEntityCreationReceipt" } } } } } }, "delete": { "tags": [ "ReportSegment" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportSegment/{reportId}/{id}": { "delete": { "tags": [ "ReportSegment" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportShare/{reportShareIdentifier}": { "get": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportShareIdentifier", "in": "path", "required": true, "schema": { "pattern": "^Z[a-zA-Z0-9]+$", "type": "string" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportShare" } } } } } } }, "/reportShare/{reportShareIdentifier}/dataSeries": { "get": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportShareIdentifier", "in": "path", "required": true, "schema": { "pattern": "^Z[a-zA-Z0-9]+$", "type": "string" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "segmentGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDataSeries" } } } } } } } }, "/reportShare/answer/{reportShareIdentifier}/{dataSeriesId}": { "get": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportShareIdentifier", "in": "path", "required": true, "schema": { "pattern": "^Z[a-zA-Z0-9]+$", "type": "string" } }, { "name": "dataSeriesId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segmentGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemCompositeStatistics" } } } } } } } }, "/reportShare/answer/{reportShareIdentifier}/{dataSeriesId}/{reportItemId}/answerList": { "get": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportShareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dataSeriesId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "segmentGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportAnswerList" } } } } } } }, "/reportShare/{reportId}": { "get": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TinyReportSharePagedList" } } } } } }, "post": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportSegmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportShareConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportShareConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportShareConfiguration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportShareConfiguration" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TinyReportShare" } } } } } }, "delete": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reportSegmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/reportShare/{reportShareIdentifier}/export": { "post": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportShareIdentifier", "in": "path", "required": true, "schema": { "pattern": "^Z[a-zA-Z0-9]+$", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DelayedSharedReportExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayedSharedReportExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayedSharedReportExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DelayedSharedReportExport" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedReportExportReceipt" } } } } } } }, "/reportShare/{reportShareIdentifier}/export/{batchId}": { "get": { "tags": [ "ReportShare" ], "parameters": [ { "name": "reportShareIdentifier", "in": "path", "required": true, "schema": { "pattern": "^Z[a-zA-Z0-9]+$", "type": "string" } }, { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportExport" } } } } } } }, "/responder/{registryId}/query": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderSortableQuery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderSortableQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderSortableQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderSortableQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderPagedList" } } } } } } }, "/responder/{registryId}/{responderId}/{fieldPeriodId}/receipt/{fileType}": { "get": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "responderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fileType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/FormExportFileType" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "onlyAnsweredQuestions", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } } } } }, "/responder/{registryId}/{responderId}": { "get": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "responderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Responder" } } } } } } }, "/responder/{registryId}": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponder" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Responder" } } } } } } }, "/responder/{registryId}/{fieldPeriodId}/testMode": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableTestModeResponder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableTestModeResponder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableTestModeResponder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableTestModeResponder" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Responder" } } } } } } }, "/responder/{registryId}/{id}": { "put": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableResponder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableResponder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableResponder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableResponder" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Responder" } } } } } }, "delete": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "OK" } } } }, "/responder/{registryId}/count": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IResponderCount" } } } } } } }, "/responder/{registryId}/count/requiredValue/{requiredMetadataId}": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "requiredMetadataId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "excludeOptedOut", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IResponderCount" } } } } } } }, "/responder/{registryId}/bulk": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponder" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponder" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponder" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponder" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreatedResponderResult" } } } } } }, "patch": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkUpdateRespondersBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateRespondersBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateRespondersBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkUpdateRespondersBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDelayedResponderBulkUpdate" } } } } } } }, "/responder/{registryId}/statistics": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderStatisticsQuery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderStatisticsQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderStatisticsQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderStatisticsQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderStatisticsResponse" } } } } } } }, "/responder/{registryId}/aggregations": { "post": { "tags": [ "Responder" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderAggregationQuery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAggregationQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderAggregationQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderAggregationQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAggregationResponse" } } } } } } }, "/responderApp": { "get": { "tags": [ "ResponderApp" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "responderRegistryId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TinyResponderAppPagedList" } } } } } }, "post": { "tags": [ "ResponderApp" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewResponderApp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewResponderApp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewResponderApp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewResponderApp" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderApp" } } } } } } }, "/responderApp/{id}": { "get": { "tags": [ "ResponderApp" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderApp" } } } } } }, "put": { "tags": [ "ResponderApp" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderApp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderApp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderApp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderApp" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderApp" } } } } } }, "delete": { "tags": [ "ResponderApp" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderApp/{id}/{cultureAlias}": { "post": { "tags": [ "ResponderApp" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "ResponderApp" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderApp/{id}/{cultureAlias}/preferred": { "put": { "tags": [ "ResponderApp" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderAppForm/{identifier}": { "get": { "tags": [ "ResponderAppForm" ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderApp" } } } } } } }, "/responderAppForm/{appIdentifier}/{fieldPeriodIdentifier}/createSession": { "post": { "tags": [ "ResponderAppForm" ], "parameters": [ { "name": "appIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldPeriodIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responderIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAppSession" } } } } } } }, "/responderAppForm/{appIdentifier}/{fieldPeriodIdentifier}/{responderIdentifier}/createSession": { "post": { "tags": [ "ResponderAppForm" ], "parameters": [ { "name": "appIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldPeriodIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responderIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderAppSession" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAppSession" } } } } } } }, "/responderAppForm/{sessionGuid}/widgets": { "get": { "tags": [ "ResponderAppForm" ], "parameters": [ { "name": "sessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAppWidgetPagedList" } } } } } } }, "/responderAppFormListWidget/{widgetId}/groups": { "get": { "tags": [ "ResponderAppFormListWidget" ], "parameters": [ { "name": "widgetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IEntityGroupWithRelationIHierarchyNode" } } } } } } } }, "/responderAppFormListWidget/{widgetId}/forms": { "get": { "tags": [ "ResponderAppFormListWidget" ], "parameters": [ { "name": "widgetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingType", "in": "query", "schema": { "$ref": "#/components/schemas/FormListingType" } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/FormOrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "groupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TinyFormPagedList" } } } } } } }, "/responderAppFormListWidget/{widgetId}/form/{formId}/fieldPeriods": { "get": { "tags": [ "ResponderAppFormListWidget" ], "parameters": [ { "name": "widgetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriod" } } } } } } } }, "/responderAppWidget/{appId}": { "get": { "tags": [ "ResponderAppWidget" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAppWidgetPagedList" } } } } } }, "post": { "tags": [ "ResponderAppWidget" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewResponderAppWidget" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewResponderAppWidget" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewResponderAppWidget" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewResponderAppWidget" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAppWidget" } } } } } } }, "/responderAppWidget/{appId}/{id}": { "get": { "tags": [ "ResponderAppWidget" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAppWidget" } } } } } }, "put": { "tags": [ "ResponderAppWidget" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAppWidget" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAppWidget" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAppWidget" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAppWidget" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAppWidget" } } } } } }, "delete": { "tags": [ "ResponderAppWidget" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderAppWidget/{appId}/{id}/{cultureAlias}": { "delete": { "tags": [ "ResponderAppWidget" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderAuth/provider": { "get": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "includePermissionForFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAuthProviderIPagedList" } } } } } }, "post": { "tags": [ "ResponderAuth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewResponderAuthProvider" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewResponderAuthProvider" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewResponderAuthProvider" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewResponderAuthProvider" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAuthProvider" } } } } } } }, "/responderAuth/provider/{id}": { "put": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAuthProvider" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAuthProvider" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAuthProvider" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderAuthProvider" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderAuthProvider" } } } } } }, "delete": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderAuth/provider/{fieldPeriodId}": { "get": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProviderOrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProviderIPagedList" } } } } } }, "post": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodResponderAuthProvider" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodResponderAuthProvider" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodResponderAuthProvider" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewFieldPeriodResponderAuthProvider" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProvider" } } } } } } }, "/responderAuth/provider/{fieldPeriodId}/{id}": { "put": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateFieldPeriodResponderAuthProvider" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFieldPeriodResponderAuthProvider" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFieldPeriodResponderAuthProvider" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFieldPeriodResponderAuthProvider" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProvider" } } } } } }, "delete": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderAuth/provider/lookup/{fieldPeriodIdentifier}/{scheme}": { "post": { "tags": [ "ResponderAuth" ], "parameters": [ { "name": "fieldPeriodIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheme", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LookupProperties" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LookupProperties" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LookupProperties" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LookupProperties" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupResponse" } } } } } } }, "/responderDataMetadata/{responderRegistryId}": { "get": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderDataMetadataPagedList" } } } } } }, "post": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadata" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadata" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderDataMetadata" } } } } } } }, "/responderDataMetadata/{responderRegistryId}/{id}": { "get": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderDataMetadata" } } } } } }, "put": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderDataMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderDataMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateResponderDataMetadata" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateResponderDataMetadata" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderDataMetadata" } } } } } }, "delete": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderDataMetadata/{responderRegistryId}/bulk": { "post": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderDataMetadataBulkItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderDataMetadataBulkItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderDataMetadataBulkItem" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderDataMetadataBulkItem" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadata" } } } } } } } }, "/responderDataMetadata/{responderRegistryId}/{responderDataMetadataId}/fieldPeriodSettings/{fieldPeriodId}": { "post": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "responderDataMetadataId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadataFieldPeriodSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadataFieldPeriodSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadataFieldPeriodSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderDataMetadataFieldPeriodSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderDataMetadata" } } } } } } }, "/responderDataMetadata/{responderRegistryId}/{responderDataMetadataId}/fieldPeriodSettings/{fieldPeriodId}/{responderDataMetadataFieldPeriodSettingId}": { "delete": { "tags": [ "ResponderDataMetadata" ], "parameters": [ { "name": "responderRegistryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "responderDataMetadataId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "responderDataMetadataFieldPeriodSettingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderDataMetadata" } } } } } } }, "/responderExport/async": { "post": { "tags": [ "ResponderExport" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DelayedResponderExportSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayedResponderExportSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayedResponderExportSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DelayedResponderExportSettings" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDelayedFileExport" } } } } } } }, "/responderForm/{fieldPeriodIdentifier}/createSession": { "post": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "fieldPeriodIdentifier", "in": "path", "required": true, "schema": { "pattern": "^F[a-zA-Z0-9]+$", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderFormSession" } } } } } } }, "/responderForm/{fieldPeriodIdentifier}/{responderIdentifier}/createSession": { "post": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "fieldPeriodIdentifier", "in": "path", "required": true, "schema": { "pattern": "^F[a-zA-Z0-9]+$", "type": "string" } }, { "name": "responderIdentifier", "in": "path", "required": true, "schema": { "pattern": "^(?:R[a-zA-Z0-9-]+|BG[a-zA-Z0-9-äöåÄÖÅ ]+)$", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderSession" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderFormSession" } } } } } } }, "/responderForm/{responderSessionGuid}/renewSession": { "patch": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderForm/{guid}": { "patch": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchResponderSessionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatchResponderSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatchResponderSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchResponderSessionRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/responderForm/{responderSessionGuid}/finishSession": { "post": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinishedResponderSession" } } } } } } }, "/responderForm/responderExport/async": { "post": { "tags": [ "ResponderForm" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DelayedResponderScopedExportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayedResponderScopedExportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayedResponderScopedExportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DelayedResponderScopedExportRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDelayedFileExport" } } } } } } }, "/responderForm/responderExport/receipt/async": { "post": { "tags": [ "ResponderForm" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DelayedResponderReceiptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayedResponderReceiptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayedResponderReceiptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DelayedResponderReceiptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDelayedFileExport" } } } } } } }, "/responderForm/{responderSessionGuid}/structure": { "get": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "fallbackToMasterCulture", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentInstanceStructure" } } } } } } }, "/responderForm/{responderSessionGuid}/translations/{cultureAlias}": { "get": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ITranslation" } } } } } } } }, "/responderForm/{responderSessionGuid}/content/dataSetTypeAhead/search": { "post": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DataSetTypeAheadSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataSetTypeAheadSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataSetTypeAheadSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DataSetTypeAheadSearchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDataSetQueryResult" } } } } } } }, "/responderForm/{responderIdentifier}/preferences": { "get": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderIdentifier", "in": "path", "required": true, "schema": { "pattern": "^(?:R[a-zA-Z0-9-]+|BG[a-zA-Z0-9-äöåÄÖÅ ]+)$", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderCurrentPreferences" } } } } } }, "post": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderIdentifier", "in": "path", "required": true, "schema": { "pattern": "^(?:R[a-zA-Z0-9-]+|BG[a-zA-Z0-9-äöåÄÖÅ ]+)$", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderPreferences" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderPreferences" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderCurrentPreferences" } } } } } } }, "/responderForm/{responderSessionGuid}/redirects": { "get": { "tags": [ "ResponderForm" ], "parameters": [ { "name": "responderSessionGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderSessionUrl" } } } } } } } }, "/responderImport/log/{registryId}/aggregations": { "get": { "tags": [ "ResponderImport" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "userScoped", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderImportLogEntryStatusAggregation" } } } } } } }, "/responderImport/log/{registryId}": { "get": { "tags": [ "ResponderImport" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "userScoped", "in": "query", "schema": { "type": "boolean" } }, { "name": "statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderBulkInsertStatus" } } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderImportLogEntryPagedList" } } } } } } }, "/responderImport/{filename}/file": { "get": { "tags": [ "ResponderImport" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderImportFile" } } } } } } }, "/responderImport/{filename}/{registryId}/file/mappingSuggestions": { "get": { "tags": [ "ResponderImport" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EditableResponderImportColumnMapping" } } } } } } } }, "/responderImport/validate/{errorCount}": { "post": { "tags": [ "ResponderImport" ], "parameters": [ { "name": "errorCount", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeRestrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRestrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderImportFileValidationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderImportFileValidationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderImportFileValidationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderImportFileValidationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportErrorRowPagedList" } } } } } } }, "/responderImport/async": { "post": { "tags": [ "ResponderImport" ], "parameters": [ { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResponderImportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponderImportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponderImportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResponderImportRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderBackgroundImportResult" } } } } } } }, "/responderImport/exportTemplate/{registryId}": { "get": { "tags": [ "ResponderImport" ], "parameters": [ { "name": "registryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictedToFieldPeriod", "in": "query", "schema": { "type": "boolean" } }, { "name": "restrictedToFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64", "deprecated": true } }, { "name": "fieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "templateContent", "in": "query", "schema": { "$ref": "#/components/schemas/ResponderImportTemplateContent" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "includeHiddenContent", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeAutoRandomizeBgData", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IReceipt" } } } } } } }, "/responderRegistry/{id}": { "get": { "tags": [ "ResponderRegistry" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderRegistry" } } } } } }, "put": { "tags": [ "ResponderRegistry" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableResponderRegistry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableResponderRegistry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableResponderRegistry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableResponderRegistry" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderRegistry" } } } } } }, "delete": { "tags": [ "ResponderRegistry" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/responderRegistry": { "get": { "tags": [ "ResponderRegistry" ], "parameters": [ { "name": "includePermissionForFieldPeriodId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderRegistryPagedList" } } } } } }, "post": { "tags": [ "ResponderRegistry" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderRegistry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderRegistry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableResponderRegistry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableResponderRegistry" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponderRegistry" } } } } } } }, "/support/article/{collection}": { "get": { "tags": [ "Support" ], "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SupportCollectionType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ISupportCategory" } } } } } } } }, "/support/search": { "get": { "tags": [ "Support" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ISupportArticle" } } } } } } } }, "/support/request": { "post": { "tags": [ "Support" ], "parameters": [ { "name": "enableAssistance", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewSupportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewSupportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewSupportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewSupportRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/support/assistance/{targetType}/{targetId}/status": { "get": { "tags": [ "Support" ], "parameters": [ { "name": "targetType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityPermissionTargetType" } }, { "name": "targetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportTeamAssistanceStatus" } } } } } } }, "/support/assistance/ensure": { "post": { "tags": [ "Support" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewSupportTeamAssistanceTarget" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewSupportTeamAssistanceTarget" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewSupportTeamAssistanceTarget" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewSupportTeamAssistanceTarget" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportTeamAssistanceStatus" } } } } } } }, "/support/assistance/{targetType}/{targetId}/remove": { "delete": { "tags": [ "Support" ], "parameters": [ { "name": "targetType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityPermissionTargetType" } }, { "name": "targetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/team/hierarchy": { "get": { "tags": [ "Team" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamHierarchyNode" } } } } } } } }, "/team/{id}": { "get": { "tags": [ "Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } } } } }, "put": { "tags": [ "Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableTeam" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableTeam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableTeam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableTeam" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } } } } }, "delete": { "tags": [ "Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/team": { "post": { "tags": [ "Team" ], "parameters": [ { "name": "parentTeamId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableTeam" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableTeam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableTeam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableTeam" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } } } } } }, "/team/{id}/members": { "get": { "tags": [ "Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "includeAppUsers", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserExtendedPagedList" } } } } } } }, "/team/{id}/{userId}": { "post": { "tags": [ "Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/translation/{targetEntityType}/{targetEntityId}/{cultureAlias}": { "get": { "tags": [ "Translation" ], "parameters": [ { "name": "targetEntityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "targetEntityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ITranslation" } } } } } } }, "put": { "tags": [ "Translation" ], "parameters": [ { "name": "targetEntityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "targetEntityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cultureAlias", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableTranslation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableTranslation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableTranslation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableTranslation" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/user": { "get": { "tags": [ "User" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "excludeInactiveUsers", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "excludeAppUsers", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TinyUserPagedList" } } } } } } }, "/user/{id}": { "get": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } }, "put": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableUser" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } }, "delete": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/user/{teamId}": { "post": { "tags": [ "User" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewUser" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } } }, "/user/currentUser": { "put": { "tags": [ "User" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCurrentUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCurrentUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCurrentUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCurrentUser" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserExtended" } } } } } } }, "/user/requests": { "get": { "tags": [ "User" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequestPagedList" } } } } } } }, "/user/request": { "post": { "tags": [ "User" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewUserRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewUserRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateUserRequestStatus" } } } } } } }, "/user/requests/{id}": { "put": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRequestResponse" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserRequestResponse" } } } }, "responses": { "200": { "description": "OK" } } } }, "/userNotification": { "get": { "tags": [ "UserNotification" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "prioritized", "in": "query", "schema": { "type": "boolean" } }, { "name": "cultureAlias", "in": "query", "schema": { "type": "string" } }, { "name": "contextType", "in": "query", "schema": { "$ref": "#/components/schemas/UserNotificationApplicationContextType" } }, { "name": "contextId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "culture", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IUserNotificationIPagedList" } } } } } } }, "/userNotification/statistics": { "get": { "tags": [ "UserNotification" ], "parameters": [ { "name": "contextType", "in": "query", "schema": { "$ref": "#/components/schemas/UserNotificationApplicationContextType" } }, { "name": "contextId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IUserNotificationStatistics" } } } } } } }, "/userNotification/readStatus": { "post": { "tags": [ "UserNotification" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/userNotification/markAllAsRead": { "post": { "tags": [ "UserNotification" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserNotificationApplicationContext" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationApplicationContext" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNotificationApplicationContext" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserNotificationApplicationContext" } } } }, "responses": { "200": { "description": "OK" } } } }, "/userReset/initiate/password": { "post": { "tags": [ "UserReset" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InitiatePasswordResetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InitiatePasswordResetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InitiatePasswordResetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InitiatePasswordResetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiatePasswordResetStatus" } } } } } } }, "/userReset/password": { "post": { "tags": [ "UserReset" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPasswordResetStatus" } } } } } } }, "/version/{entityType}/{entityId}": { "get": { "tags": [ "Version" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/VersionableEntityType" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 128 } }, { "name": "orderByField", "in": "query", "schema": { "$ref": "#/components/schemas/OrderByField" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionPagedList" } } } } } } }, "/version/{entityType}/{entityId}/{id}": { "get": { "tags": [ "Version" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/VersionableEntityType" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } } } }, "put": { "tags": [ "Version" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/VersionableEntityType" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatableVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatableVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatableVersion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatableVersion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } } } }, "delete": { "tags": [ "Version" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/VersionableEntityType" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/version/{entityType}/{entityId}/{originId}": { "post": { "tags": [ "Version" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/VersionableEntityType" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "originId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatableVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatableVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatableVersion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatableVersion" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } } } } } }, "components": { "schemas": { "AccessedObject": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/EntityType" }, "time": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AclType": { "enum": [ "None", "Read", "Write", "Administer", "Owner", "Inherited" ], "type": "string" }, "Activity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "formId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ActivityPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" }, "nullable": true } }, "additionalProperties": false }, "AggregationStatisticsResponse": { "type": "object", "properties": { "min": { "type": "number", "format": "double", "nullable": true }, "max": { "type": "number", "format": "double", "nullable": true }, "average": { "type": "number", "format": "double", "nullable": true }, "sum": { "type": "number", "format": "double", "nullable": true }, "key": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "AggregationStatisticsResponseAggregationBucketSingleResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "aggregation": { "$ref": "#/components/schemas/AggregationStatisticsResponse" } }, "additionalProperties": false }, "AllowedAlternativeInput": { "enum": [ "Undefined", "Predefined", "Custom" ], "type": "string" }, "Alternative": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "header": { "type": "string", "nullable": true }, "imageFile": { "$ref": "#/components/schemas/FileWithPublicUrl" }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "AlternativeAnswer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "customValue": { "nullable": true }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" } }, "additionalProperties": false }, "AnswerListDisplayType": { "enum": [ "Text", "Coordinate", "File", "Canvas", "Decimal", "Integer", "Date", "DateTime" ], "type": "string" }, "AnswerListDisplayTypeIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/AnswerListDisplayType" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AnswerListDisplayTypeInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/AnswerListDisplayTypeIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/AnswerListDisplayType" }, "calculatedValue": { "$ref": "#/components/schemas/AnswerListDisplayType" } }, "additionalProperties": false }, "AnswerListDisplayTypeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/AnswerListDisplayType" } }, "additionalProperties": false }, "AnswerStorageResult": { "type": "object", "properties": { "segmentGuid": { "type": "string", "format": "uuid" }, "storedAnswersCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AnswerValidator": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contentId": { "type": "integer", "format": "int64" }, "validationType": { "$ref": "#/components/schemas/ValidationType" }, "entityType": { "$ref": "#/components/schemas/ValidatorEntityType" }, "entityId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "settings": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerValidatorSetting" }, "nullable": true } }, "additionalProperties": false }, "AnswerValidatorPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerValidator" }, "nullable": true } }, "additionalProperties": false }, "AnswerValidatorSetting": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AnswersContainer": { "type": "object", "properties": { "optionAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/OptionQuestionAnswer" }, "nullable": true }, "optionMatrixAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/OptionMatrixQuestionAnswer" }, "nullable": true }, "textMatrixAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/TextMatrixQuestionAnswer" }, "nullable": true }, "rankingAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/RankingQuestionAnswer" }, "nullable": true }, "inputAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/InputQuestionAnswer" }, "nullable": true }, "canvasAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CanvasQuestionAnswer" }, "nullable": true }, "mapAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/MapAnswer" }, "nullable": true }, "fileAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/FileQuestionAnswer" }, "nullable": true }, "textMultipleFieldsAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/TextMultipleFieldsQuestionAnswer" }, "nullable": true }, "scaleAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/ScaleAnswer" }, "nullable": true }, "dataSetTypeAheadAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/DataSetTypeAheadAnswer" }, "nullable": true }, "areaSegmenterAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/AreaSegmenterAnswer" }, "nullable": true }, "areaRepeaterAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/AreaRepeaterAnswer" }, "nullable": true } }, "additionalProperties": false }, "Area": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaUiSettings" }, "contentInstances": { "type": "array", "items": { "$ref": "#/components/schemas/ContentInstanceReference" }, "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "AreaRepeater": { "type": "object", "properties": { "labels": { "$ref": "#/components/schemas/AreaRepeaterLabels" }, "uiSettings": { "$ref": "#/components/schemas/AreaRepeaterUiSettings" }, "contentInstance": { "$ref": "#/components/schemas/ContentInstanceReference" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "AreaRepeaterAnswer": { "type": "object", "properties": { "segments": { "type": "array", "items": { "$ref": "#/components/schemas/AreaRepeaterSegmentAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "AreaRepeaterColumn": { "type": "object", "properties": { "displayMode": { "$ref": "#/components/schemas/AreaRepeaterColumnDisplayMode" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/LocalizedStringTranslation" }, "nullable": true }, "contentInstanceUris": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AreaRepeaterColumnDisplayMode": { "enum": [ "Display", "Sum" ], "type": "string" }, "AreaRepeaterDisplayType": { "enum": [ "Default", "Checklist" ], "type": "string" }, "AreaRepeaterLabels": { "type": "object", "properties": { "addAreaButtonLabel": { "type": "string", "nullable": true }, "submitAreaButtonLabel": { "type": "string", "nullable": true }, "segmentsMissingLabel": { "type": "string", "nullable": true }, "deleteAnswerSegmentConfirm": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AreaRepeaterSegmentAnswer": { "type": "object", "properties": { "segmentGuid": { "type": "string", "format": "uuid" }, "isChecked": { "type": "boolean" } }, "additionalProperties": false }, "AreaRepeaterUiSettings": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/components/schemas/AreaRepeaterColumn" }, "nullable": true }, "displayType": { "$ref": "#/components/schemas/AreaRepeaterDisplayType" }, "showSummary": { "type": "boolean" }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AreaSegmenter": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/AreaSegmenterUiSettings" }, "contentInstance": { "$ref": "#/components/schemas/ContentInstanceReference" }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/AreaSegmenterAlternative" }, "nullable": true }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "AreaSegmenterAlternative": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "AreaSegmenterAlternativeAnswer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "segmentGuid": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AreaSegmenterAnswer": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/AreaSegmenterAlternativeAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "AreaSegmenterTemplate": { "enum": [ "Undefined", "None", "Monthly" ], "type": "string" }, "AreaSegmenterUiSettings": { "type": "object", "properties": { "segmentTemplate": { "$ref": "#/components/schemas/AreaSegmenterTemplate" }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AreaUiSettings": { "type": "object", "properties": { "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AsyncReindexResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AsyncReindexResponseNodeResponse": { "type": "object", "properties": { "node": { "type": "string", "nullable": true }, "object": { "$ref": "#/components/schemas/AsyncReindexResponse" } }, "additionalProperties": false }, "AuthenticatedUser": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "identityProviders": { "type": "array", "items": { "type": "string" }, "nullable": true }, "customer": { "$ref": "#/components/schemas/IUserCustomer" }, "id": { "type": "integer", "format": "int64" }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "cellphone": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UserStatus" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureClaim" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/IUserUiSettings" }, "isActive": { "type": "boolean", "readOnly": true }, "isServiceUser": { "type": "boolean" }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "propertyBag": { "$ref": "#/components/schemas/IUserPropertyBag" } }, "additionalProperties": false }, "Base64File": { "type": "object", "properties": { "base64String": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BiResponderExportStarted": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "BooleanIOptionalProperty": { "type": "object", "properties": { "value": { "type": "boolean", "readOnly": true }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BooleanInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/BooleanIOptionalProperty" }, "inheritedValue": { "type": "boolean" }, "calculatedValue": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BooleanOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "boolean" } }, "additionalProperties": false }, "BulkCreatedResponderResult": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BulkUpdateReportItemInstructions": { "type": "object", "properties": { "reportItemId": { "type": "integer", "format": "int64" }, "uiSettings": { "$ref": "#/components/schemas/BulkUpdateReportItemUiSettings" } }, "additionalProperties": false }, "BulkUpdateReportItemUiSettings": { "type": "object", "properties": { "isHidden": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "BulkUpdateResponderPatch": { "type": "object", "properties": { "isActive": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "isUsedForTesting": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "isOptedOut": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "responderData": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderData" }, "nullable": true } }, "additionalProperties": false }, "BulkUpdateRespondersBody": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ResponderQuery" }, "patch": { "$ref": "#/components/schemas/BulkUpdateResponderPatch" } }, "additionalProperties": false }, "ButtonType": { "enum": [ "CheckboxButton", "Button", "Checkbox" ], "type": "string" }, "CanvasQuestion": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/CanvasQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CanvasQuestionAnswer": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/File" }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "CanvasQuestionUiSettings": { "type": "object", "properties": { "size": { "$ref": "#/components/schemas/CanvasSize" }, "enableColorPicker": { "type": "boolean" }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CanvasSize": { "enum": [ "Undefined", "Small", "Medium", "Large" ], "type": "string" }, "ChartLegendType": { "enum": [ "Hidden", "Top", "Bottom", "Left", "Right" ], "type": "string" }, "ChartLegendTypeIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ChartLegendType" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChartLegendTypeInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ChartLegendTypeIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ChartLegendType" }, "calculatedValue": { "$ref": "#/components/schemas/ChartLegendType" } }, "additionalProperties": false }, "ChartLegendTypeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ChartLegendType" } }, "additionalProperties": false }, "ChartType": { "enum": [ "Pie", "Bar", "Column", "StackedBar", "StackedColumn", "Line", "Radar", "None" ], "type": "string" }, "ChartTypeIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ChartType" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChartTypeInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ChartTypeIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ChartType" }, "calculatedValue": { "$ref": "#/components/schemas/ChartType" } }, "additionalProperties": false }, "ChartTypeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ChartType" } }, "additionalProperties": false }, "ChartValueFormat": { "enum": [ "Count", "Share" ], "type": "string" }, "ChartValueFormatIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ChartValueFormat" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChartValueFormatInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ChartValueFormatIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ChartValueFormat" }, "calculatedValue": { "$ref": "#/components/schemas/ChartValueFormat" } }, "additionalProperties": false }, "ChartValueFormatOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ChartValueFormat" } }, "additionalProperties": false }, "ChatConversationDetail": { "type": "object", "properties": { "conversation": { "$ref": "#/components/schemas/ChatConversationSummary" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" }, "nullable": true } }, "additionalProperties": false }, "ChatConversationSummary": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid" }, "title": { "type": "string", "nullable": true }, "scope": { "$ref": "#/components/schemas/ChatScope" }, "focusEntityId": { "type": "integer", "format": "int64", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ChatConversationSummaryPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatConversationSummary" }, "nullable": true } }, "additionalProperties": false }, "ChatFocus": { "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/ChatScope" }, "entityId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ChatMessage": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/ChatMessageRole" }, "content": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatMessageRequest": { "type": "object", "properties": { "conversationId": { "type": "string", "format": "uuid", "nullable": true }, "userMessage": { "type": "string", "nullable": true }, "focus": { "$ref": "#/components/schemas/ChatFocus" } }, "additionalProperties": false }, "ChatMessageResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "format": "uuid" }, "assistantMessage": { "$ref": "#/components/schemas/ChatMessage" } }, "additionalProperties": false }, "ChatMessageRole": { "enum": [ "User", "Assistant" ], "type": "string" }, "ChatScope": { "enum": [ "General", "FormVersion", "FieldPeriod", "Report", "UsersAndTeams", "ResponderApp", "ResponderRegistry" ], "type": "string" }, "CloneUserPermissions": { "required": [ "fromUserId", "toUserId" ], "type": "object", "properties": { "fromUserId": { "type": "integer", "format": "int64" }, "toUserId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ColorPalette": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "hexColors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ColorPalettePagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ColorPalette" }, "nullable": true } }, "additionalProperties": false }, "ConditionFilterTarget": { "type": "object", "properties": { "contentConditionId": { "type": "integer", "format": "int64" }, "uri": { "type": "string", "nullable": true }, "filterId": { "type": "integer", "format": "int64" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ConditionFilterTargetConditionContext": { "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/ContentStructureContext" }, "entityId": { "type": "integer", "format": "int64" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionFilterTarget" }, "nullable": true } }, "additionalProperties": false }, "ConditionTarget": { "type": "object", "properties": { "uri": { "type": "string", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionTargetGroup" }, "nullable": true } }, "additionalProperties": false }, "ConditionTargetGroup": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionTrigger" }, "nullable": true } }, "additionalProperties": false }, "ConditionTrigger": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "conditionGroupIdentifier": { "type": "string", "format": "uuid" }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "format": "uri", "nullable": true }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "subQuestionId": { "type": "integer", "format": "int64", "nullable": true }, "alternativeId": { "type": "integer", "format": "int64", "nullable": true }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "value": { "nullable": true } }, "additionalProperties": false }, "ContentAlternativeDisplayType": { "enum": [ "Undefined", "Title", "Image" ], "type": "string" }, "ContentBucket": { "type": "object", "properties": { "pagedItems": { "$ref": "#/components/schemas/Int64PagedList" }, "haveInstances": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "content": { "$ref": "#/components/schemas/ContentContainer" } }, "additionalProperties": false }, "ContentBucketScopeLevel": { "enum": [ "Undefined", "Global", "FormVersion", "Form" ], "type": "string" }, "ContentCondition": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contextEntityType": { "$ref": "#/components/schemas/ContentStructureContext" }, "contextEntityId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "format": "uri", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "filter": { "$ref": "#/components/schemas/Filter" } }, "additionalProperties": false }, "ContentContainer": { "type": "object", "properties": { "optionQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OptionQuestion" }, "nullable": true }, "optionMatrixQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OptionMatrixQuestion" }, "nullable": true }, "textMatrixQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/TextMatrixQuestion" }, "nullable": true }, "scaleQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ScaleQuestion" }, "nullable": true }, "mapQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/MapQuestion" }, "nullable": true }, "sortableQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/RankingQuestion" }, "nullable": true }, "inputQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/InputQuestion" }, "nullable": true }, "fileQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/FileQuestion" }, "nullable": true }, "canvasQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/CanvasQuestion" }, "nullable": true }, "textMultipleFieldsQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/TextMultipleFieldsQuestion" }, "nullable": true }, "dataSetTypeAheadQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/DataSetTypeAheadQuestion" }, "nullable": true }, "texts": { "type": "array", "items": { "$ref": "#/components/schemas/Text" }, "nullable": true }, "areas": { "type": "array", "items": { "$ref": "#/components/schemas/Area" }, "nullable": true }, "areaRepeaters": { "type": "array", "items": { "$ref": "#/components/schemas/AreaRepeater" }, "nullable": true }, "areaSegmenters": { "type": "array", "items": { "$ref": "#/components/schemas/AreaSegmenter" }, "nullable": true } }, "additionalProperties": false }, "ContentExport": { "required": [ "instanceTree" ], "type": "object", "properties": { "instanceTree": { "$ref": "#/components/schemas/ImportableInstanceTree" }, "contentBucketStorage": { "type": "array", "items": { "$ref": "#/components/schemas/ContentImportBucketStorage" }, "nullable": true }, "validators": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableAnswerValidator" }, "nullable": true }, "localizedContent": { "type": "array", "items": { "$ref": "#/components/schemas/LocalizedContentImportContainer" }, "nullable": true } }, "additionalProperties": false }, "ContentExportSettings": { "type": "object", "properties": { "contentInstanceUris": { "type": "array", "items": { "type": "string", "format": "uri" }, "nullable": true } }, "additionalProperties": false }, "ContentFilterEntry": { "type": "object", "properties": { "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "subQuestionId": { "type": "integer", "format": "int64", "nullable": true }, "alternativeId": { "type": "integer", "format": "int64", "nullable": true }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "value": { "nullable": true }, "id": { "type": "integer", "format": "int64", "readOnly": true }, "filterId": { "type": "integer", "format": "int64", "readOnly": true }, "filterGuid": { "type": "string", "format": "uuid", "readOnly": true }, "identifier": { "type": "string", "format": "uuid", "readOnly": true }, "groupIdentifier": { "type": "string", "format": "uuid", "readOnly": true } }, "additionalProperties": false }, "ContentFilterOperator": { "enum": [ "Undefined", "Equals", "NotEquals", "GreaterThan", "LessThan", "GreaterThanOrEquals", "LessThanOrEquals", "NotEmpty", "Empty" ], "type": "string" }, "ContentImport": { "required": [ "instanceTree" ], "type": "object", "properties": { "instanceTree": { "$ref": "#/components/schemas/ImportableInstanceTree" }, "contentBucketStorage": { "type": "array", "items": { "$ref": "#/components/schemas/ContentImportBucketStorage" }, "nullable": true }, "validators": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableAnswerValidator" }, "nullable": true }, "localizedContent": { "type": "array", "items": { "$ref": "#/components/schemas/LocalizedContentImportContainer" }, "nullable": true } }, "additionalProperties": false }, "ContentImportBucketStorage": { "type": "object", "properties": { "scope": { "$ref": "#/components/schemas/ContentBucketScopeLevel" }, "identifier": { "minimum": 1, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ContentImportContainer": { "type": "object", "properties": { "optionQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableOptionQuestion" }, "nullable": true }, "optionMatrixQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableOptionMatrixQuestion" }, "nullable": true }, "textMatrixQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableTextMatrixQuestion" }, "nullable": true }, "scaleQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableScaleQuestion" }, "nullable": true }, "mapQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableMapQuestion" }, "nullable": true }, "rankingQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableRankingQuestion" }, "nullable": true }, "inputQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableInputQuestion" }, "nullable": true }, "fileQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableFileQuestion" }, "nullable": true }, "canvasQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableCanvasQuestion" }, "nullable": true }, "textMultipleFieldsQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableTextMultipleFieldsQuestion" }, "nullable": true }, "texts": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableText" }, "nullable": true }, "dataSetTypeAheadQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableDataSetTypeAheadQuestion" }, "nullable": true }, "areas": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableArea" }, "nullable": true }, "areaRepeaters": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableAreaRepeater" }, "nullable": true }, "areaSegmenters": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableAreaSegmenter" }, "nullable": true } }, "additionalProperties": false }, "ContentImportResult": { "type": "object", "properties": { "addedCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ContentInstanceReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contentId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ContentInstanceReferenceIHaveInstanceNodes": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ContentInstanceReferenceIInstanceNode" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ContentInstanceReferenceIInstanceNode": { "type": "object", "properties": { "uri": { "type": "string", "format": "uri", "nullable": true }, "instance": { "$ref": "#/components/schemas/ContentInstanceReference" }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ContentInstanceReferenceIInstanceNode" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ContentInstanceSourceCollection": { "required": [ "contentInstanceUris", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "contentInstanceUris": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "additionalProperties": false }, "ContentInstanceSourceCollections": { "type": "object", "properties": { "formVersionId": { "type": "integer", "format": "int64" }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/ContentInstanceSourceCollection" }, "nullable": true } }, "additionalProperties": false }, "ContentInstanceStructure": { "type": "object", "properties": { "instanceTree": { "$ref": "#/components/schemas/ContentInstanceReferenceIHaveInstanceNodes" }, "sharedContent": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "content": { "$ref": "#/components/schemas/ContentContainer" } }, "additionalProperties": false }, "ContentInstancesSortOrder": { "required": [ "contentInstanceIds" ], "type": "object", "properties": { "contentInstanceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false }, "ContentStructureContext": { "enum": [ "Undefined", "FormVersion", "Area" ], "type": "string" }, "ContentSubQuestionDisplayType": { "enum": [ "Undefined", "Title", "Image" ], "type": "string" }, "ContentType": { "enum": [ "Undefined", "Text", "InputQuestion", "TextMultipleFieldsQuestion", "OptionQuestion", "OptionMatrixQuestion", "TextMatrixQuestion", "RankingQuestion", "Area", "AreaRepeater", "AreaSegmenter", "FileQuestion", "CanvasQuestion", "MapQuestion", "ScaleQuestion", "DataSetTypeAheadQuestion" ], "type": "string" }, "ContentValueResolverConfiguration": { "required": [ "contentInstanceUri" ], "type": "object", "properties": { "formVersionId": { "minimum": 1, "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Coordinates": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CostCenter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "overdraftLimit": { "type": "number", "format": "double", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "organizationNumber": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "invoiceDetails": { "$ref": "#/components/schemas/CostCenterInvoiceDetails" }, "contactPerson": { "$ref": "#/components/schemas/CostCenterContactPerson" } }, "additionalProperties": false }, "CostCenterContactPerson": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CostCenterIPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CostCenter" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CostCenterInvoiceDetails": { "type": "object", "properties": { "address": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "referenceNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CostCenterTransaction": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "costCenterId": { "type": "integer", "format": "int64" }, "reservedAt": { "type": "string", "format": "date-time", "nullable": true }, "transactedAt": { "type": "string", "format": "date-time", "nullable": true }, "type": { "$ref": "#/components/schemas/CostCenterTransactionType" }, "summary": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "balanceAfterTransaction": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CostCenterTransactionFilter": { "type": "object", "properties": { "entityReference": { "$ref": "#/components/schemas/EntityReference" }, "transactionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "transactionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/CostCenterTransactionType" }, "nullable": true } }, "additionalProperties": false }, "CostCenterTransactionIPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CostCenterTransaction" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CostCenterTransactionType": { "enum": [ "Deposit", "Invoice", "AuthenticationCostWithdrawal", "SmsCostWithdrawal", "Undefined" ], "type": "string" }, "CostCenterWithBalance": { "type": "object", "properties": { "balance": { "type": "number", "format": "double" }, "reservedCredits": { "type": "number", "format": "double", "readOnly": true }, "balanceWithReserved": { "type": "number", "format": "double", "readOnly": true }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "overdraftLimit": { "type": "number", "format": "double", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "organizationNumber": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "invoiceDetails": { "$ref": "#/components/schemas/CostCenterInvoiceDetails" }, "contactPerson": { "$ref": "#/components/schemas/CostCenterContactPerson" } }, "additionalProperties": false }, "Country": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "trunkCode": { "type": "string", "nullable": true }, "personalIdentityNumberFormat": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableAlternative": { "required": [ "answerValueType", "title" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "CreatableAlternativeAnswer": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "customValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableAnswerValidator": { "required": [ "contentId" ], "type": "object", "properties": { "contentId": { "type": "integer", "format": "int64" }, "validationType": { "$ref": "#/components/schemas/ValidationType" }, "entityType": { "$ref": "#/components/schemas/ValidatorEntityType" }, "entityId": { "minimum": 1, "type": "integer", "format": "int64" }, "settings": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAnswerValidatorSetting" }, "nullable": true } }, "additionalProperties": false }, "CreatableAnswerValidatorSetting": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreatableAnswers": { "type": "object", "properties": { "optionAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableOptionQuestionAnswer" }, "nullable": true }, "optionMatrixAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableOptionMatrixQuestionAnswer" }, "nullable": true }, "textMatrixAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableTextMatrixQuestionAnswer" }, "nullable": true }, "sortableAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableRankingQuestionAnswer" }, "nullable": true }, "inputAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableInputQuestionAnswer" }, "nullable": true }, "fileAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableFileQuestionAnswer" }, "nullable": true }, "canvasAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableCanvasQuestionAnswer" }, "nullable": true }, "mapAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableMapQuestionAnswer" }, "nullable": true }, "scaleAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableScaleQuestionAnswer" }, "nullable": true }, "textMultipleFieldsAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableTextMultipleFieldsQuestionAnswer" }, "nullable": true }, "dataSetTypeAheadAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableDataSetTypeAheadQuestionAnswer" }, "nullable": true }, "areaSegmenterAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAreaSegmenterAnswer" }, "nullable": true }, "areaRepeaterAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAreaRepeaterAnswer" }, "nullable": true } }, "additionalProperties": false }, "CreatableArea": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaUiSettings" } }, "additionalProperties": false }, "CreatableAreaRepeater": { "required": [ "contentId", "cultureAlias", "title" ], "type": "object", "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaRepeaterUiSettings" }, "contentId": { "type": "integer", "format": "int64" }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "labels": { "$ref": "#/components/schemas/CreatableAreaRepeaterLabels" } }, "additionalProperties": false }, "CreatableAreaRepeaterAnswer": { "type": "object", "properties": { "segments": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAreaRepeaterSegmentAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "CreatableAreaRepeaterLabels": { "type": "object", "properties": { "addAreaButtonLabel": { "type": "string", "nullable": true }, "submitAreaButtonLabel": { "type": "string", "nullable": true }, "segmentsMissingLabel": { "type": "string", "nullable": true }, "deleteAnswerSegmentConfirm": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableAreaRepeaterSegmentAnswer": { "required": [ "segmentGuid" ], "type": "object", "properties": { "segmentGuid": { "type": "string", "format": "uuid" }, "isChecked": { "type": "boolean" } }, "additionalProperties": false }, "CreatableAreaSegmenter": { "required": [ "contentId", "cultureAlias", "title" ], "type": "object", "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaSegmenterUiSettings" }, "isPersonalData": { "type": "boolean", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAreaSegmenterAlternative" }, "nullable": true } }, "additionalProperties": false }, "CreatableAreaSegmenterAlternative": { "required": [ "title" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string" }, "additionalNumberValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CreatableAreaSegmenterAlternativeAnswer": { "required": [ "id", "segmentGuid" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "segmentGuid": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreatableAreaSegmenterAnswer": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAreaSegmenterAlternativeAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "CreatableCanvasQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/CanvasQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableCanvasQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableContentCondition": { "type": "object", "properties": { "contextEntityType": { "$ref": "#/components/schemas/ContentStructureContext" }, "contextEntityId": { "type": "integer", "format": "int64" }, "filterId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "CreatableCustomizableAlternative": { "required": [ "allowedInput", "answerValueType", "title" ], "type": "object", "properties": { "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "header": { "type": "string", "nullable": true }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "CreatableDataSetTypeAheadQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "dataSetProviderId": { "type": "integer", "format": "int64" }, "dataSetProviderSettings": { "type": "array", "items": { "$ref": "#/components/schemas/MutableDataSetProviderSetting" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/DataSetTypeAheadQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableDataSetTypeAheadQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "dataSetItemId": { "type": "string", "nullable": true }, "dataSetItemSummary": { "type": "string", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableEntityGroup": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreatableEvent": { "required": [ "name" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/EventType" }, "name": { "minLength": 1, "type": "string" }, "trigger": { "$ref": "#/components/schemas/EventTriggerType" }, "disabled": { "type": "boolean" }, "filterId": { "type": "integer", "format": "int64", "nullable": true }, "redirectEventConfiguration": { "$ref": "#/components/schemas/FieldPeriodRedirectEventConfiguration" }, "emailEventConfiguration": { "$ref": "#/components/schemas/EmailEventConfiguration" }, "receiptEventConfiguration": { "$ref": "#/components/schemas/ReceiptEventConfiguration" }, "createResponderEventConfiguration": { "$ref": "#/components/schemas/CreateResponderEventConfiguration" }, "dataSetStorageEventConfiguration": { "$ref": "#/components/schemas/CreateDataSetStorageEventConfiguration" }, "currentFormRestartEventConfiguration": { "$ref": "#/components/schemas/CurrentFormRestartEventConfiguration" }, "urlRedirectEventConfiguration": { "$ref": "#/components/schemas/UrlRedirectEventConfiguration" } }, "additionalProperties": false }, "CreatableFieldPeriod": { "required": [ "name" ], "type": "object", "properties": { "formVersionId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "responderRegistryId": { "minimum": 1, "type": "integer", "format": "int64" }, "activateAt": { "type": "string", "format": "date-time", "nullable": true }, "finishAt": { "type": "string", "format": "date-time", "nullable": true }, "maximumNbrOfFinishedResponders": { "type": "integer", "format": "int32", "nullable": true }, "allowPublicLink": { "type": "boolean", "nullable": true }, "allowResponderResuming": { "type": "boolean", "nullable": true }, "enableDataExportForResponder": { "type": "boolean", "nullable": true }, "interimAnswerSaveMode": { "$ref": "#/components/schemas/InterimAnswerSaveMode" }, "clearExistingAnswersForResponder": { "type": "boolean", "nullable": true }, "respondersAreAlwaysDistributed": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/FieldPeriodUiSettings" }, "requireResponderAppAuthentication": { "type": "boolean" }, "disableAuthForResponderLinks": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableFileQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/FileQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableFileQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableForm": { "required": [ "name", "relationship", "templateId" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "templateId": { "type": "integer", "format": "int64" }, "relationship": { "$ref": "#/components/schemas/FormRelationshipNamesRelationship" } }, "additionalProperties": false }, "CreatableFormTemplate": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "uiType": { "$ref": "#/components/schemas/ResponderUiType" }, "css": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "receiptTemplateFileName": { "type": "string", "format": "uuid", "nullable": true }, "exportTemplateFileName": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreatableInputQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableInputQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "metadata": { "$ref": "#/components/schemas/InputAnswerMetadata" }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableMapQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/MapQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableMapQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/Coordinates" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableOptionMatrixQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableSubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableCustomizableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionMatrixQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableOptionMatrixQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri", "subQuestions" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableOptionMatrixSubQuestionAnswer" } }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableOptionMatrixSubQuestionAnswer": { "required": [ "alternatives", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAlternativeAnswer" } } }, "additionalProperties": false }, "CreatableOptionQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableCustomizableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableOptionQuestionAnswer": { "required": [ "alternatives", "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAlternativeAnswer" } }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableRankedAlternativeAnswer": { "required": [ "id", "sortOrder" ], "type": "object", "properties": { "sortOrder": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "customValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableRankingAlternative": { "required": [ "allowedInput", "answerValueType", "title" ], "type": "object", "properties": { "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "CreatableRankingQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableRankingAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/RankingQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableRankingQuestionAnswer": { "required": [ "alternatives", "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableRankedAlternativeAnswer" } }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableResponder": { "type": "object", "properties": { "responderType": { "$ref": "#/components/schemas/ResponderType" }, "responderData": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderData" }, "nullable": true }, "isActive": { "type": "boolean" }, "isUsedForTesting": { "type": "boolean" }, "isOptedOut": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableResponderAppSession": { "type": "object", "properties": { "environmentProperties": { "$ref": "#/components/schemas/CreatableResponderEnvironment" }, "queryParameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CreatableResponderData": { "type": "object", "properties": { "metadataId": { "type": "integer", "format": "int64" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableResponderDataMetadata": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 2147483647, "minLength": 1, "type": "string" }, "valueType": { "$ref": "#/components/schemas/ResponderDataMetadataType" }, "isPersonalData": { "type": "boolean", "nullable": true }, "useAsAlternativeResponderIdentifier": { "type": "boolean", "nullable": true }, "autoRandomizeUniqueValue": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ResponderDataMetadataUiSettings" } }, "additionalProperties": false }, "CreatableResponderDataMetadataBulkItem": { "required": [ "name" ], "type": "object", "properties": { "fieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "restrictedToFieldPeriod": { "type": "boolean" }, "name": { "maxLength": 2147483647, "minLength": 1, "type": "string" }, "valueType": { "$ref": "#/components/schemas/ResponderDataMetadataType" }, "isPersonalData": { "type": "boolean", "nullable": true }, "useAsAlternativeResponderIdentifier": { "type": "boolean", "nullable": true }, "autoRandomizeUniqueValue": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ResponderDataMetadataUiSettings" } }, "additionalProperties": false }, "CreatableResponderDataMetadataFieldPeriodSetting": { "required": [ "valueString" ], "type": "object", "properties": { "settingType": { "$ref": "#/components/schemas/ResponderDataFieldPeriodSettingType" }, "formVersionId": { "type": "integer", "format": "int64", "nullable": true }, "valueString": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreatableResponderEnvironment": { "type": "object", "properties": { "userAgent": { "type": "string", "nullable": true }, "browserName": { "type": "string", "nullable": true }, "browserVersion": { "type": "string", "nullable": true }, "osName": { "type": "string", "nullable": true }, "osVersion": { "type": "string", "nullable": true }, "deviceType": { "$ref": "#/components/schemas/DeviceType" } }, "additionalProperties": false }, "CreatableResponderRegistry": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 2147483647, "minLength": 1, "type": "string" }, "respondersAreAnonymous": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableResponderSession": { "type": "object", "properties": { "environmentProperties": { "$ref": "#/components/schemas/CreatableResponderEnvironment" }, "queryParameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CreatableScalePoint": { "required": [ "value" ], "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" }, "imageFileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableScaleQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableScalePoint" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ScaleQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableScaleQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "point": { "type": "number", "format": "double", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableScopedContent": { "required": [ "contentId", "scopeLevel" ], "type": "object", "properties": { "scopeLevel": { "$ref": "#/components/schemas/ContentBucketScopeLevel" }, "targetEntityId": { "type": "integer", "format": "int64", "nullable": true }, "contentId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CreatableSegmentedAnswers": { "type": "object", "properties": { "segmentGuid": { "type": "string", "format": "uuid" }, "answers": { "$ref": "#/components/schemas/CreatableAnswers" } }, "additionalProperties": false }, "CreatableSubQuestion": { "required": [ "title" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string" }, "referenceName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "CreatableTeam": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreatableTestModeResponder": { "type": "object", "properties": { "responderData": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderData" }, "nullable": true } }, "additionalProperties": false }, "CreatableText": { "required": [ "content", "cultureAlias" ], "type": "object", "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/TextUiSettings" }, "cultureAlias": { "minLength": 1, "type": "string" }, "content": { "$ref": "#/components/schemas/MarkupText" } }, "additionalProperties": false }, "CreatableTextMatrixAlternativeAnswer": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableTextMatrixQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableSubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/QuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableTextMatrixQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri", "subQuestions" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableTextMatrixSubQuestionAnswer" } }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableTextMatrixSubQuestionAnswer": { "required": [ "alternatives", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableTextMatrixAlternativeAnswer" } } }, "additionalProperties": false }, "CreatableTextMultipleFieldsQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableTypedSubQuestion" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatableTextMultipleFieldsQuestionAnswer": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri", "subQuestions" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableTextTextMultipleFieldsSubQuestionAnswer" } }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableTextTextMultipleFieldsSubQuestionAnswer": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatableTypedSubQuestion": { "required": [ "title" ], "type": "object", "properties": { "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "title": { "minLength": 1, "type": "string" }, "referenceName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "CreatableVersion": { "required": [ "versionName" ], "type": "object", "properties": { "versionName": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreateDataSetStorageEventConfiguration": { "type": "object", "properties": { "dataSetProviderId": { "type": "integer", "format": "int64" }, "dataSetProviderSettings": { "type": "array", "items": { "$ref": "#/components/schemas/MutableDataSetProviderSetting" }, "nullable": true } }, "additionalProperties": false }, "CreateReportItemIndex": { "required": [ "collections", "cultureAlias", "indexType", "name" ], "type": "object", "properties": { "indexType": { "$ref": "#/components/schemas/ReportItemIndexType" }, "collections": { "$ref": "#/components/schemas/ContentInstanceSourceCollections" }, "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemIndexUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "CreateReportItemMatrixStatistics": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "collections": { "$ref": "#/components/schemas/ContentInstanceSourceCollections" }, "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemMatrixStatisticsUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "CreateReportItemResponseRate": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "CreateResponderEventConfiguration": { "type": "object", "properties": { "responderRegistryId": { "minimum": 1, "type": "integer", "format": "int64" }, "restrictedToFieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "autoRedirect": { "type": "boolean" }, "responderType": { "$ref": "#/components/schemas/ResponderType" }, "dataMappings": { "type": "array", "items": { "$ref": "#/components/schemas/CreateResponderEventDataMappings" }, "nullable": true }, "redirectDelay": { "$ref": "#/components/schemas/RedirectDelayType" } }, "additionalProperties": false }, "CreateResponderEventDataMappings": { "type": "object", "properties": { "targetDataMetadataId": { "type": "integer", "format": "int64" }, "sourceResolver": { "$ref": "#/components/schemas/EventConfigurationValueResolverConfiguration" } }, "additionalProperties": false }, "Culture": { "type": "object", "properties": { "alias": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "nativeName": { "type": "string", "nullable": true }, "isRightToLeft": { "type": "boolean" }, "country": { "$ref": "#/components/schemas/Country" }, "flagIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentFormRestartEventConfiguration": { "type": "object", "properties": { "redirectDelay": { "$ref": "#/components/schemas/RedirectDelayType" } }, "additionalProperties": false }, "CustomerCapability": { "enum": [ "SchoolSoftDistribution", "AiAssistant" ], "type": "string" }, "CustomerOrganizationType": { "enum": [ "Company", "Cooperative", "LaborUnion", "PoliticalParty", "NonprofitOrganization", "Foundation", "GovernmentAgency", "Municipality", "EmployerAndIndustryAssociation", "Undefined" ], "type": "string" }, "DataSeriesBody": { "type": "object", "properties": { "dataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "DataSetProviderCapability": { "enum": [ "Query", "Add" ], "type": "string" }, "DataSetProviderConfigurationValueType": { "enum": [ "ContentInstanceUri", "Boolean", "String", "List", "Undefined" ], "type": "string" }, "DataSetProviderDefinition": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "DataSetStorageEventConfiguration": { "type": "object", "properties": { "dataSetProviderId": { "type": "integer", "format": "int64" }, "dataSetProviderSettings": { "type": "array", "items": { "$ref": "#/components/schemas/IDataSetProviderSetting" }, "nullable": true } }, "additionalProperties": false }, "DataSetTypeAheadAnswer": { "type": "object", "properties": { "dataSetItemId": { "type": "string", "nullable": true }, "dataSetItemSummary": { "type": "string", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "DataSetTypeAheadQueryParameter": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataSetTypeAheadQuestion": { "type": "object", "properties": { "dataSetProviderId": { "type": "integer", "format": "int64" }, "dataSetProviderSettings": { "type": "array", "items": { "$ref": "#/components/schemas/IDataSetProviderSetting" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/DataSetTypeAheadQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DataSetTypeAheadQuestionUiSettings": { "type": "object", "properties": { "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DataSetTypeAheadSearchRequest": { "required": [ "contentInstanceUri" ], "type": "object", "properties": { "contentInstanceUri": { "type": "string", "format": "uri" }, "query": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/DataSetTypeAheadQueryParameter" }, "nullable": true } }, "additionalProperties": false }, "DateTimeIOptionalProperty": { "type": "object", "properties": { "value": { "type": "string", "format": "date-time", "readOnly": true }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DateTimeNullableOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DelayedReportExport": { "required": [ "cultureAlias", "timeZoneName" ], "type": "object", "properties": { "fileType": { "$ref": "#/components/schemas/FileType" }, "timeZoneName": { "minLength": 1, "type": "string" }, "cultureAlias": { "minLength": 1, "type": "string" }, "reportSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "reportItemIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "templateFileName": { "type": "string", "format": "uuid", "nullable": true }, "textsAsAppendix": { "type": "boolean" } }, "additionalProperties": false }, "DelayedResponderExportSettings": { "required": [ "cultureAlias" ], "type": "object", "properties": { "fieldPeriodId": { "minimum": 1, "type": "integer", "format": "int64" }, "cultureAlias": { "minLength": 1, "type": "string" }, "fallbackToMasterCulture": { "type": "boolean" }, "timeZoneName": { "type": "string", "nullable": true }, "disablePasswordProtection": { "type": "boolean" }, "includeResponders": { "type": "boolean" }, "includeResponderBackgroundData": { "type": "boolean" }, "includeAnswers": { "type": "boolean" }, "includeSectionHeaders": { "type": "boolean" }, "swedishPersonalIdentityNumberFormat": { "$ref": "#/components/schemas/SwedishPersonalIdentityNumberFormat" }, "useAlternativeNumberValue": { "type": "boolean" }, "useReferenceNames": { "type": "boolean" }, "defaultAlternativeNumberValue": { "type": "number", "format": "double", "nullable": true }, "query": { "$ref": "#/components/schemas/ResponderQuery" } }, "additionalProperties": false }, "DelayedResponderReceiptRequest": { "required": [ "email", "preferredCultureAlias" ], "type": "object", "properties": { "responderSessionGuid": { "type": "string", "format": "uuid" }, "email": { "minLength": 1, "pattern": "^[-0-9a-zA-ZäöåÄÖÅ.+_]+@[-0-9a-zA-ZäöåÄÖÅ.+_]+\\.[a-zA-Z]{2,63}$", "type": "string" }, "fileType": { "$ref": "#/components/schemas/FormExportFileType" }, "preferredCultureAlias": { "minLength": 1, "type": "string" }, "fieldPeriodMessageId": { "type": "integer", "format": "int64", "nullable": true }, "onlyAnsweredQuestions": { "type": "boolean" } }, "additionalProperties": false }, "DelayedResponderScopedExportRequest": { "required": [ "cultureAlias", "email" ], "type": "object", "properties": { "responderSessionGuid": { "type": "string", "format": "uuid" }, "email": { "minLength": 1, "pattern": "^[-0-9a-zA-ZäöåÄÖÅ.+_]+@[-0-9a-zA-ZäöåÄÖÅ.+_]+\\.[a-zA-Z]{2,63}$", "type": "string" }, "cultureAlias": { "minLength": 1, "pattern": "^[a-z]{2,3}(-[A-Z]{2})*", "type": "string" }, "timeZoneName": { "type": "string", "nullable": true }, "fallbackToMasterCulture": { "type": "boolean" } }, "additionalProperties": false }, "DelayedSharedReportExport": { "required": [ "cultureAlias", "timeZoneName" ], "type": "object", "properties": { "fileType": { "$ref": "#/components/schemas/FileType" }, "timeZoneName": { "minLength": 1, "type": "string" }, "cultureAlias": { "minLength": 1, "type": "string" }, "segmentGuid": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DepositReceipt": { "type": "object", "properties": { "costCenterId": { "type": "integer", "format": "int64" }, "transactionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "DeviceType": { "enum": [ "Console", "Mobile", "Tablet", "Smarttv", "Wearable", "Embedded", "Undefined" ], "type": "string" }, "DeviceTypeCounter": { "type": "object", "properties": { "tabletCount": { "type": "integer", "format": "int64" }, "mobileCount": { "type": "integer", "format": "int64" }, "desktopCount": { "type": "integer", "format": "int64" }, "otherCount": { "type": "integer", "format": "int64" }, "tabletShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "mobileShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "desktopShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "otherShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "totalCount": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "DoubleNullableIOptionalProperty": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DoubleNullableInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DoubleNullableIOptionalProperty" }, "inheritedValue": { "type": "number", "format": "double", "nullable": true }, "calculatedValue": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "DoubleNullableOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "EditableEntityPermission": { "type": "object", "properties": { "access": { "$ref": "#/components/schemas/AclType" }, "allowInheritanceForTeams": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "EditableResponderImportColumnMapping": { "required": [ "fileColumnId" ], "type": "object", "properties": { "metadataId": { "type": "integer", "format": "int64", "nullable": true }, "metadataType": { "$ref": "#/components/schemas/ResponderDataMetadataType" }, "isPersonalData": { "type": "boolean", "nullable": true }, "restrictedToFieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "metadataName": { "type": "string", "nullable": true }, "fileColumnId": { "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EmailEventConfiguration": { "type": "object", "properties": { "fieldPeriodMessageId": { "minimum": 1, "type": "integer", "format": "int64" }, "senderFriendlyName": { "type": "string", "nullable": true }, "recipientAddress": { "type": "string", "nullable": true }, "resolvers": { "type": "array", "items": { "$ref": "#/components/schemas/EventConfigurationValueResolverConfiguration" }, "nullable": true } }, "additionalProperties": false }, "EntityGroupType": { "enum": [ "Undefined", "Form" ], "type": "string" }, "EntityPermission": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "sourceType": { "$ref": "#/components/schemas/EntityPermissionSourceType" }, "sourceId": { "type": "integer", "format": "int64" }, "targetType": { "$ref": "#/components/schemas/EntityPermissionTargetType" }, "targetId": { "type": "integer", "format": "int64" }, "access": { "$ref": "#/components/schemas/AclType" }, "allowInheritanceForTeams": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "EntityPermissionSourceType": { "enum": [ "Undefined", "User", "Team", "Form", "FieldPeriod", "EntityGroup", "Report", "Content", "Event" ], "type": "string" }, "EntityPermissionTargetType": { "enum": [ "Undefined", "FormTemplate", "Form", "Content", "ResponderRegistry", "Report", "ResponderApp", "FieldPeriod", "EntityGroup", "ColorPalette", "DataSetProvider", "ResponderAuthProvider", "CostCenter", "FileBucket" ], "type": "string" }, "EntityReference": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/EntityType" }, "id": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "EntityType": { "enum": [ "Undefined", "Customer", "Form", "Question", "SubQuestion", "Alternative", "FormVersion", "Activity", "FieldPeriod", "FormTemplate", "User", "Team", "FieldPeriodMessage", "Text", "Content", "ContentInstance", "Area", "ResponderRegistry", "Report", "ResponderApp", "ResponderDistributionBatch", "ResponderDataMetadata", "EntityGroup", "ColorPalette", "DataSetProvider", "ResponderAuthProvider", "CostCenter", "FileBucket" ], "type": "string" }, "Event": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fieldPeriodId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "trigger": { "$ref": "#/components/schemas/EventTriggerType" }, "type": { "$ref": "#/components/schemas/EventType" }, "disabled": { "type": "boolean" }, "filterId": { "type": "integer", "format": "int64", "nullable": true }, "redirectEventConfiguration": { "$ref": "#/components/schemas/FieldPeriodRedirectEventConfiguration" }, "emailEventConfiguration": { "$ref": "#/components/schemas/EmailEventConfiguration" }, "receiptEventConfiguration": { "$ref": "#/components/schemas/ReceiptEventConfiguration" }, "createResponderEventConfiguration": { "$ref": "#/components/schemas/CreateResponderEventConfiguration" }, "dataSetStorageEventConfiguration": { "$ref": "#/components/schemas/DataSetStorageEventConfiguration" }, "urlRedirectEventConfiguration": { "$ref": "#/components/schemas/UrlRedirectEventConfiguration" }, "currentFormRestartEventConfiguration": { "$ref": "#/components/schemas/CurrentFormRestartEventConfiguration" } }, "additionalProperties": false }, "EventConfigurationValueResolverConfiguration": { "type": "object", "properties": { "resolverType": { "$ref": "#/components/schemas/EventConfigurationValueResolverType" }, "responderDataMetadataValueResolver": { "$ref": "#/components/schemas/ResponderDataMetadataValueResolverConfiguration" }, "contentValueResolver": { "$ref": "#/components/schemas/ContentValueResolverConfiguration" }, "responderSessionValueResolver": { "$ref": "#/components/schemas/ResponderSessionValueResolverConfiguration" } }, "additionalProperties": false }, "EventConfigurationValueResolverType": { "enum": [ "Undefined", "ResponderDataMetadata", "Content", "ResponderSession" ], "type": "string" }, "EventPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Event" }, "nullable": true } }, "additionalProperties": false }, "EventTriggerType": { "enum": [ "Undefined", "ResponderSessionFinished", "ResponderCreated" ], "type": "string" }, "EventType": { "enum": [ "Undefined", "FieldPeriodRedirectEvent", "ReceiptEvent", "EmailEvent", "CreateResponderEvent", "CurrentFormRestartEvent", "DataSetStorageEvent", "UrlRedirectEvent" ], "type": "string" }, "FeatureClaim": { "enum": [ "UserManagement", "UserRequestManagement", "ResponderAppManagement", "FormManagement", "ResponderAuthProviderManagement", "CostCenterManagement", "SchoolSoftDistribution" ], "type": "string" }, "FieldPeriod": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "identifier": { "type": "string", "nullable": true }, "openUrlIdentifier": { "type": "string", "nullable": true }, "activityId": { "type": "integer", "format": "int64" }, "formVersionId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "responderRegistryId": { "type": "integer", "format": "int64" }, "activateAt": { "type": "string", "format": "date-time", "nullable": true }, "finishAt": { "type": "string", "format": "date-time", "nullable": true }, "maximumNbrOfFinishedResponders": { "type": "integer", "format": "int32", "nullable": true }, "allowPublicLink": { "type": "boolean" }, "allowResponderResuming": { "type": "boolean" }, "enableDataExportForResponder": { "type": "boolean" }, "interimAnswerSaveMode": { "$ref": "#/components/schemas/InterimAnswerSaveMode" }, "clearExistingAnswersForResponder": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "activationState": { "$ref": "#/components/schemas/FieldPeriodActivationState" }, "respondersAreAlwaysDistributed": { "type": "boolean", "nullable": true }, "preferredCultureResponderDataMetadataId": { "type": "integer", "format": "int64", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/FieldPeriodUiSettings" }, "requireResponderAppAuthentication": { "type": "boolean" }, "disableAuthForResponderLinks": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "FieldPeriodActivationState": { "enum": [ "NotStarted", "Ongoing", "FinishedByTime", "FinishedByMaximumNbrOfResponders" ], "type": "string" }, "FieldPeriodMessage": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "distributionType": { "$ref": "#/components/schemas/ResponderDistributionType" }, "title": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "subject": { "type": "string", "nullable": true }, "body": { "$ref": "#/components/schemas/MarkupText" } }, "additionalProperties": false }, "FieldPeriodMessageBatch": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "guid": { "type": "string", "format": "uuid" }, "committed": { "type": "boolean" }, "committedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "failed": { "type": "boolean", "nullable": true }, "failedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "initiatedAtUtc": { "type": "string", "format": "date-time" }, "failReason": { "type": "string", "nullable": true }, "recipientCount": { "type": "integer", "format": "int64" }, "isResponderCountersStale": { "type": "boolean" }, "spawnedBatchGuid": { "type": "string", "format": "uuid", "nullable": true }, "distributionType": { "$ref": "#/components/schemas/ResponderDistributionType" }, "messageId": { "type": "integer", "format": "int64" }, "messageCulture": { "type": "string", "nullable": true }, "messageSubject": { "type": "string", "nullable": true }, "messageBody": { "type": "string", "nullable": true }, "triggeredBy": { "$ref": "#/components/schemas/ResponderDistributionBatchTrigger" }, "costCenterId": { "type": "integer", "format": "int64", "nullable": true }, "costCenterTransactionGuid": { "type": "string", "format": "uuid", "nullable": true }, "anonymousIntegrityStatus": { "$ref": "#/components/schemas/ResponderIntegrityGuardStatus" } }, "additionalProperties": false }, "FieldPeriodMessageBatchPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodMessageBatch" }, "nullable": true } }, "additionalProperties": false }, "FieldPeriodMessageDistributionForecast": { "type": "object", "properties": { "receiverMetadataId": { "type": "integer", "format": "int64" }, "responderQuery": { "$ref": "#/components/schemas/ResponderQuery" }, "cultureConfiguration": { "$ref": "#/components/schemas/FieldPeriodMessageDistributionForecastCultureConfiguration" } }, "additionalProperties": false }, "FieldPeriodMessageDistributionForecastCultureConfiguration": { "type": "object", "properties": { "metadataId": { "type": "integer", "format": "int64", "nullable": true }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodMessageDistributionForecastCultureMapping" }, "nullable": true } }, "additionalProperties": false }, "FieldPeriodMessageDistributionForecastCultureMapping": { "type": "object", "properties": { "responderCultureAlias": { "type": "string", "nullable": true }, "messageCultureAlias": { "type": "string", "nullable": true }, "responderCulture": { "type": "string", "nullable": true, "readOnly": true }, "messageCulture": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FieldPeriodMessagePagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodMessage" }, "nullable": true } }, "additionalProperties": false }, "FieldPeriodPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriod" }, "nullable": true } }, "additionalProperties": false }, "FieldPeriodRedirectEventConfiguration": { "type": "object", "properties": { "fieldPeriodId": { "type": "integer", "format": "int64" }, "redirectDelay": { "$ref": "#/components/schemas/RedirectDelayType" } }, "additionalProperties": false }, "FieldPeriodResponderAuthProvider": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fieldPeriodId": { "type": "integer", "format": "int64" }, "authProvider": { "$ref": "#/components/schemas/ResponderAuthProvider" }, "costCenterId": { "type": "integer", "format": "int64", "nullable": true }, "autoProvisioning": { "type": "boolean" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/IFieldPeriodResponderAuthProviderMappingField" }, "nullable": true }, "autoProvisionMappings": { "type": "array", "items": { "$ref": "#/components/schemas/IFieldPeriodResponderAuthProviderAutoProvisionMappingField" }, "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "FieldPeriodResponderAuthProviderAutoProvisionMappingField": { "required": [ "metadataId" ], "type": "object", "properties": { "claim": { "$ref": "#/components/schemas/ResponderAuthProviderAutoProvisionMappingDefinitionClaim" }, "metadataId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "FieldPeriodResponderAuthProviderIPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProvider" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FieldPeriodResponderAuthProviderMappingField": { "required": [ "metadataId" ], "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/ResponderAuthProviderMappingDefinitionFieldIdentifier" }, "metadataId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "FieldPeriodResponderAuthProviderOrderByField": { "enum": [ "Undefined", "Id", "Priority" ], "type": "string" }, "FieldPeriodUiSettings": { "type": "object", "properties": { "htmlDocumentTitle": { "type": "string", "nullable": true }, "showProgressBar": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "FieldPeriodUiSettingsOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/FieldPeriodUiSettings" } }, "additionalProperties": false }, "File": { "type": "object", "properties": { "contentLength": { "type": "integer", "format": "int64" }, "contentType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "originalName": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "uploaded": { "type": "string", "format": "date-time" }, "fileStorageType": { "$ref": "#/components/schemas/FileStorageType" } }, "additionalProperties": false }, "FileFormat": { "enum": [ "Undefined", "Pdf", "Word", "Excel", "PowerPoint", "Image", "WordTemplate", "VectorImage", "InSurveyContentExport" ], "type": "string" }, "FileQuestion": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/FileQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "FileQuestionAnswer": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/File" }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "FileQuestionUiSettings": { "type": "object", "properties": { "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "FileStorageType": { "enum": [ "Undefined", "Permanent", "Temp" ], "type": "string" }, "FileType": { "enum": [ "Undefined", "Xlsx", "Pdf", "Docx", "PdfDocument" ], "type": "string" }, "FileWithPublicUrl": { "type": "object", "properties": { "publicUrl": { "type": "string", "format": "uri", "nullable": true }, "contentLength": { "type": "integer", "format": "int64" }, "contentType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "originalName": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "uploaded": { "type": "string", "format": "date-time" }, "fileStorageType": { "$ref": "#/components/schemas/FileStorageType" } }, "additionalProperties": false }, "Filter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "guid": { "type": "string", "format": "uuid" }, "contentFilterEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ContentFilterEntry" }, "nullable": true }, "reportItemFilterEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemFilterEntry" }, "nullable": true } }, "additionalProperties": false }, "FilterOperator": { "enum": [ "Undefined", "Equals", "NotEquals", "GreaterThan", "LessThan", "GreaterThanOrEquals", "LessThanOrEquals", "NotEmpty", "Empty" ], "type": "string" }, "FinishedResponderSession": { "type": "object", "properties": { "responderSessionGuid": { "type": "string", "format": "uuid" }, "shouldRedirect": { "type": "boolean" } }, "additionalProperties": false }, "Form": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "uiType": { "$ref": "#/components/schemas/ResponderUiType" }, "templateId": { "type": "integer", "format": "int64" }, "templateIdentifier": { "type": "string", "nullable": true }, "templateLegacyIdentifier": { "type": "string", "nullable": true }, "versionId": { "type": "integer", "format": "int64" }, "versionName": { "type": "string", "nullable": true }, "answerSegmentGuid": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "preferredCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "existingContentCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FormCopy": { "required": [ "name", "relationship", "templateId" ], "type": "object", "properties": { "templateId": { "type": "integer", "format": "int64" }, "name": { "minLength": 1, "type": "string" }, "relationship": { "$ref": "#/components/schemas/FormCopyRelationshipNamesRelationship" } }, "additionalProperties": false }, "FormCopyRelationshipNames": { "required": [ "emailResponderDataMetaDataName", "fieldPeriod", "responderRegistry", "version" ], "type": "object", "properties": { "version": { "minLength": 1, "type": "string" }, "fieldPeriod": { "minLength": 1, "type": "string" }, "responderRegistry": { "minLength": 1, "type": "string" }, "emailResponderDataMetaDataName": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "FormCopyRelationshipNamesRelationship": { "required": [ "cultureAlias", "names" ], "type": "object", "properties": { "cultureAlias": { "minLength": 1, "type": "string" }, "fieldPeriodIsAlwaysDistributed": { "type": "boolean" }, "names": { "$ref": "#/components/schemas/FormCopyRelationshipNames" } }, "additionalProperties": false }, "FormExportFileType": { "enum": [ "Undefined", "Docx", "Pdf" ], "type": "string" }, "FormExportType": { "enum": [ "Docx", "Pdf" ], "type": "string" }, "FormListWidgetConfiguration": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "header": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "canOpenExistingForms": { "type": "boolean" }, "openExistingFormButtonText": { "type": "string", "nullable": true }, "openNewFormButtonText": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "FormListingType": { "enum": [ "All", "MyForms", "DirectSharedForms" ], "type": "string" }, "FormOrderByField": { "enum": [ "Undefined", "Id", "Name" ], "type": "string" }, "FormRelationshipNames": { "required": [ "emailResponderDataMetaDataName", "fieldPeriod", "firstPage", "responderRegistry", "version" ], "type": "object", "properties": { "version": { "minLength": 1, "type": "string" }, "firstPage": { "minLength": 1, "type": "string" }, "fieldPeriod": { "minLength": 1, "type": "string" }, "responderRegistry": { "minLength": 1, "type": "string" }, "emailResponderDataMetaDataName": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "FormRelationshipNamesRelationship": { "required": [ "cultureAlias", "names" ], "type": "object", "properties": { "cultureAlias": { "minLength": 1, "type": "string" }, "fieldPeriodIsAlwaysDistributed": { "type": "boolean" }, "names": { "$ref": "#/components/schemas/FormRelationshipNames" } }, "additionalProperties": false }, "FormTemplate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "identifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "uiType": { "$ref": "#/components/schemas/ResponderUiType" }, "css": { "type": "string", "nullable": true }, "cssUrl": { "$ref": "#/components/schemas/Url" }, "cssClass": { "type": "string", "nullable": true }, "receiptTemplateFile": { "$ref": "#/components/schemas/File" }, "exportTemplateFile": { "$ref": "#/components/schemas/File" } }, "additionalProperties": false }, "FormTemplatePagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FormTemplate" }, "nullable": true } }, "additionalProperties": false }, "FormVersionStatistics": { "type": "object", "properties": { "formId": { "type": "integer", "format": "int64" }, "formVersionId": { "type": "integer", "format": "int64" }, "fieldPeriodResponderSessionStatistics": { "type": "array", "items": { "$ref": "#/components/schemas/IFieldPeriodResponderSessionStatistics" }, "nullable": true } }, "additionalProperties": false }, "FriendlyObjectIdentity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetFieldPeriodStatisticsRequestBody": { "type": "object", "properties": { "responderQuery": { "$ref": "#/components/schemas/ResponderQuery" } }, "additionalProperties": false }, "Hello": { "type": "object", "properties": { "dateTime": { "type": "string", "format": "date-time" }, "nullableDateTime": { "type": "string", "format": "date-time", "nullable": true }, "guid": { "type": "string", "format": "uuid" }, "nullValue": { "nullable": true }, "enum": { "$ref": "#/components/schemas/HelloEnum" }, "redisLatency": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "HelloEnum": { "enum": [ "HelloWorld", "Goodbye" ], "type": "string" }, "IAnswerTargetReference": { "type": "object", "additionalProperties": false }, "IAsyncBackgroundTask": { "type": "object", "properties": { "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IBiAnswer": { "type": "object", "properties": { "guid": { "type": "string", "format": "uuid", "readOnly": true }, "segmentGuid": { "type": "string", "format": "uuid", "readOnly": true }, "uri": { "type": "string", "nullable": true, "readOnly": true }, "contentInstanceUri": { "type": "string", "nullable": true, "readOnly": true }, "positionIndex": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "alternativeId": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "alternativeUri": { "type": "string", "nullable": true, "readOnly": true }, "valueString": { "type": "string", "nullable": true, "readOnly": true }, "valueDecimal": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "coordinateLat": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "coordinateLong": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "valueSegmentGuid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IBiDefinition": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "form": { "type": "array", "items": { "$ref": "#/components/schemas/IBiFormItemDefinition" }, "nullable": true, "readOnly": true }, "responderDataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/IBiResponderDataMetadataDefinition" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IBiFormItemAlternatives": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "uri": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "weight": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IBiFormItemDefinition": { "type": "object", "properties": { "uri": { "type": "string", "nullable": true, "readOnly": true }, "type": { "$ref": "#/components/schemas/QuestionType" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "referenceName": { "type": "string", "nullable": true, "readOnly": true }, "parentName": { "type": "string", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/IBiFormItemAlternatives" }, "nullable": true, "readOnly": true }, "isMandatory": { "type": "boolean", "nullable": true, "readOnly": true }, "min": { "type": "string", "nullable": true, "readOnly": true }, "max": { "type": "string", "nullable": true, "readOnly": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "IBiResponder": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "identifier": { "type": "string", "nullable": true, "readOnly": true }, "guid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "formAnswerSegmentGuid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/IBiAnswer" }, "nullable": true, "readOnly": true }, "responderData": { "type": "array", "items": { "$ref": "#/components/schemas/IBiResponderData" }, "nullable": true, "readOnly": true }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "state": { "$ref": "#/components/schemas/ResponderSessionState" } }, "additionalProperties": false }, "IBiResponderData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "value": { "type": "string", "nullable": true, "readOnly": true }, "isPersonalData": { "type": "boolean", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IBiResponderDataMetadataDefinition": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "isPersonalData": { "type": "boolean", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IBiResponderPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IBiResponder" }, "nullable": true } }, "additionalProperties": false }, "IClonedContentReceipt": { "type": "object", "properties": { "contentId": { "$ref": "#/components/schemas/Int64IChangedValue" }, "contentInstanceId": { "$ref": "#/components/schemas/Int64IChangedValue" }, "contentInstanceUri": { "$ref": "#/components/schemas/StringIChangedValue" }, "clonedContentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ContentType" }, "nullable": true } }, "additionalProperties": false }, "ICoordinates": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ICostCenterBalance": { "type": "object", "properties": { "balance": { "type": "number", "format": "double", "readOnly": true }, "reservedCredits": { "type": "number", "format": "double", "readOnly": true }, "balanceWithReserved": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "IDataSetProviderConfigurationSchemaProperty": { "type": "object", "properties": { "valueType": { "$ref": "#/components/schemas/DataSetProviderConfigurationValueType" }, "fieldName": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "array", "items": { "$ref": "#/components/schemas/LocalizedStringTranslation" }, "nullable": true, "readOnly": true }, "isRequired": { "type": "boolean", "readOnly": true }, "defaultValue": { "nullable": true, "readOnly": true }, "useAsResponderPayload": { "type": "boolean", "readOnly": true }, "subSchema": { "type": "array", "items": { "$ref": "#/components/schemas/IDataSetProviderConfigurationSchemaProperty" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IDataSetProviderSetting": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataSetProviderConfigurationValueType" }, "key": { "type": "string", "nullable": true, "readOnly": true }, "value": { "nullable": true, "readOnly": true }, "useAsResponderPayload": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "IDataSetQueryItem": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "summary": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IDataSetQueryResult": { "type": "object", "properties": { "hits": { "type": "array", "items": { "$ref": "#/components/schemas/IDataSetQueryItem" }, "nullable": true, "readOnly": true }, "nbrOfHits": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "IDelayedFileExport": { "type": "object", "properties": { "jobId": { "type": "string", "nullable": true, "readOnly": true }, "willBeSentTo": { "type": "string", "nullable": true, "readOnly": true }, "fileProtectionPassword": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IDelayedResponderBulkUpdate": { "type": "object", "properties": { "jobId": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IEntityGroup": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "entityType": { "$ref": "#/components/schemas/EntityType" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "IEntityGroupWithRelation": { "type": "object", "properties": { "access": { "$ref": "#/components/schemas/AclType" }, "isShared": { "type": "boolean" }, "id": { "type": "integer", "format": "int64", "readOnly": true }, "entityType": { "$ref": "#/components/schemas/EntityType" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "IEntityGroupWithRelationIHierarchyNode": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/IEntityGroupWithRelation" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/IEntityGroupWithRelationIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "IFieldPeriodResponderAuthProviderAutoProvisionMappingField": { "type": "object", "properties": { "claim": { "$ref": "#/components/schemas/ResponderAuthProviderAutoProvisionMappingDefinitionClaim" }, "metadataId": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "IFieldPeriodResponderAuthProviderMappingField": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/ResponderAuthProviderMappingDefinitionFieldIdentifier" }, "metadataId": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "IFieldPeriodResponderSessionStatistics": { "type": "object", "properties": { "fieldPeriodId": { "type": "integer", "format": "int64", "readOnly": true }, "responderType": { "$ref": "#/components/schemas/ResponderType" }, "count": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "IFieldPeriodStatistics": { "type": "object", "properties": { "responderCount": { "type": "integer", "format": "int64", "readOnly": true }, "deviceType": { "$ref": "#/components/schemas/DeviceTypeCounter" }, "responderState": { "$ref": "#/components/schemas/ResponderStateCounter" }, "mailStatus": { "$ref": "#/components/schemas/MailStatusCounter" }, "anonymousIntegrityStatus": { "$ref": "#/components/schemas/ResponderIntegrityGuardStatus" } }, "additionalProperties": false }, "IIdentifierPatternDecodeResult": { "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/IdentifierPatternEntityType" }, "id": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "INewsEntry": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "readOnly": true }, "link": { "type": "string", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "content": { "type": "string", "nullable": true, "readOnly": true }, "imageUrl": { "type": "string", "nullable": true, "readOnly": true }, "publishedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "INumberStatistics": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "readOnly": true }, "sum": { "type": "number", "format": "double", "readOnly": true }, "average": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "max": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "min": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IReceipt": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true, "readOnly": true }, "url": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IReportEntityCreationReceipt": { "type": "object", "properties": { "nbrOfSegmentsCreated": { "type": "integer", "format": "int64", "readOnly": true }, "nbrOfDataSourcesCreated": { "type": "integer", "format": "int64", "readOnly": true }, "nbrOfDataSeriesCreated": { "type": "integer", "format": "int64", "readOnly": true }, "nbrOfDataSeriesFiltersCreated": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "IReportSegment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "reportId": { "type": "integer", "format": "int64", "readOnly": true }, "parentReportSegmentGuid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "initialSegmentedWithFilterGuid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true }, "filterGuid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IReportSegmentIHierarchyNode": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/IReportSegment" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/IReportSegmentIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "IReportSegmentPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IReportSegment" }, "nullable": true } }, "additionalProperties": false }, "IResponderAuthProviderAutoProvisionMappingDefinition": { "type": "object", "properties": { "mappingFields": { "type": "array", "items": { "$ref": "#/components/schemas/IResponderAuthProviderAutoProvisionMappingDefinitionField" }, "nullable": true } }, "additionalProperties": false }, "IResponderAuthProviderAutoProvisionMappingDefinitionField": { "type": "object", "properties": { "claim": { "$ref": "#/components/schemas/ResponderAuthProviderAutoProvisionMappingDefinitionClaim" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "metadataType": { "$ref": "#/components/schemas/ResponderDataMetadataType" } }, "additionalProperties": false }, "IResponderAuthProviderMappingDefinition": { "type": "object", "properties": { "mappingFields": { "type": "array", "items": { "$ref": "#/components/schemas/IResponderAuthProviderMappingDefinitionField" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IResponderAuthProviderMappingDefinitionField": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/ResponderAuthProviderMappingDefinitionFieldIdentifier" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "metadataType": { "$ref": "#/components/schemas/ResponderDataMetadataType" }, "isRequired": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "IResponderCount": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "IResponderImportFileHeader": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true, "readOnly": true }, "value": { "type": "string", "nullable": true, "readOnly": true }, "columnId": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "IResponderQueryRestrictions": { "type": "object", "properties": { "onlyFinished": { "$ref": "#/components/schemas/BooleanIOptionalProperty" }, "onlyFinishedAfter": { "$ref": "#/components/schemas/DateTimeIOptionalProperty" }, "onlyFinishedBefore": { "$ref": "#/components/schemas/DateTimeIOptionalProperty" }, "includeTestResponders": { "$ref": "#/components/schemas/BooleanIOptionalProperty" }, "includeInactiveResponders": { "$ref": "#/components/schemas/BooleanIOptionalProperty" } }, "additionalProperties": false }, "ISendOutForecast": { "type": "object", "properties": { "totalResponderCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalMessagePartCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPrice": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ISendOutForecastDetail" }, "nullable": true, "readOnly": true }, "anonymousIntegrityStatus": { "$ref": "#/components/schemas/ResponderIntegrityGuardStatus" } }, "additionalProperties": false }, "ISendOutForecastDetail": { "type": "object", "properties": { "responderCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "responderCount": { "type": "integer", "format": "int64", "readOnly": true }, "messageCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "messagePartCount": { "type": "integer", "format": "int64", "readOnly": true }, "price": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "anonymousIntegrityStatus": { "$ref": "#/components/schemas/ResponderIntegrityGuardStatus" } }, "additionalProperties": false }, "IStatisticMeasures": { "type": "object", "properties": { "mean": { "type": "number", "format": "double", "nullable": true }, "mode": { "type": "number", "format": "double", "nullable": true }, "median": { "type": "number", "format": "double", "nullable": true }, "variance": { "type": "number", "format": "double", "nullable": true }, "standardDeviation": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ISupportArticle": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "url": { "type": "string", "nullable": true, "readOnly": true }, "preview": { "type": "string", "nullable": true, "readOnly": true }, "inScope": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ISupportCategory": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "url": { "type": "string", "nullable": true, "readOnly": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/ISupportArticle" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ITranslation": { "type": "object", "properties": { "key": { "type": "string", "nullable": true, "readOnly": true }, "value": { "type": "string", "nullable": true, "readOnly": true }, "source": { "$ref": "#/components/schemas/TranslationSource" } }, "additionalProperties": false }, "IUserCustomer": { "type": "object", "properties": { "organizationType": { "$ref": "#/components/schemas/CustomerOrganizationType" }, "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerCapability" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IUserNotification": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "target": { "$ref": "#/components/schemas/UserNotificationTarget" }, "targetId": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "messageType": { "$ref": "#/components/schemas/UserNotificationMessageType" }, "messageLevel": { "$ref": "#/components/schemas/UserNotificationMessageLevel" }, "summary": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true, "readOnly": true }, "applicationContextType": { "$ref": "#/components/schemas/UserNotificationApplicationContextType" }, "applicationContextId": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "isPrioritized": { "type": "boolean", "readOnly": true }, "isPushed": { "type": "boolean", "readOnly": true }, "isRead": { "type": "boolean", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IUserNotificationIPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IUserNotification" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IUserNotificationStatistics": { "type": "object", "properties": { "messagesCount": { "type": "integer", "format": "int64", "readOnly": true }, "unReadMessagesCount": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "IUserPropertyBag": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/UserPropertyBagEntry" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IUserUiSettings": { "type": "object", "properties": { "floatingWorkbenchHeader": { "type": "boolean", "nullable": true }, "floatingWorkbenchFlowBar": { "type": "boolean", "nullable": true }, "editorFormDefaultValues": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "accessedObjects": { "type": "array", "items": { "$ref": "#/components/schemas/AccessedObject" }, "nullable": true } }, "additionalProperties": false }, "IdentifierPatternEntityType": { "enum": [ "Responder", "FieldPeriod", "FormTemplate", "ResponderApp", "Report", "ReportShare" ], "type": "string" }, "ImportErrorRow": { "type": "object", "properties": { "fileRow": { "type": "integer", "format": "int64" }, "givenValue": { "type": "string", "nullable": true }, "expectedType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImportErrorRowPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImportErrorRow" }, "nullable": true } }, "additionalProperties": false }, "ImportableAlternative": { "required": [ "answerValueType", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "ImportableAnswerValidator": { "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "validationType": { "$ref": "#/components/schemas/ValidationType" }, "entityType": { "$ref": "#/components/schemas/ValidatorEntityType" }, "entityId": { "minimum": 1, "type": "integer", "format": "int64" }, "settings": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableAnswerValidatorSetting" }, "nullable": true } }, "additionalProperties": false }, "ImportableArea": { "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaUiSettings" } }, "additionalProperties": false }, "ImportableAreaRepeater": { "required": [ "contentId", "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaRepeaterUiSettings" }, "contentId": { "type": "integer", "format": "int64" }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "labels": { "$ref": "#/components/schemas/CreatableAreaRepeaterLabels" } }, "additionalProperties": false }, "ImportableAreaSegmenter": { "required": [ "contentId", "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaSegmenterUiSettings" }, "isPersonalData": { "type": "boolean", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableAreaSegmenterAlternative" }, "nullable": true } }, "additionalProperties": false }, "ImportableAreaSegmenterAlternative": { "required": [ "title" ], "type": "object", "properties": { "identifier": { "type": "integer", "format": "int64" }, "title": { "minLength": 1, "type": "string" }, "additionalNumberValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ImportableCanvasQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "uiSettings": { "$ref": "#/components/schemas/CanvasQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableCustomizableAlternative": { "required": [ "allowedInput", "answerValueType", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "header": { "type": "string", "nullable": true }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "ImportableDataSetTypeAheadQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "dataSetProviderId": { "type": "integer", "format": "int64" }, "dataSetProviderSettings": { "type": "array", "items": { "$ref": "#/components/schemas/MutableDataSetProviderSetting" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/DataSetTypeAheadQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableFileQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "uiSettings": { "$ref": "#/components/schemas/FileQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableInputQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableInstanceNode": { "required": [ "uri" ], "type": "object", "properties": { "uri": { "type": "string", "format": "uri" }, "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableInstanceNode" }, "nullable": true } }, "additionalProperties": false }, "ImportableInstanceTree": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableInstanceNode" }, "nullable": true } }, "additionalProperties": false }, "ImportableMapQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "uiSettings": { "$ref": "#/components/schemas/MapQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableOptionMatrixQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableSubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableCustomizableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionMatrixQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableOptionQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableCustomizableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableRankingAlternative": { "required": [ "allowedInput", "answerValueType", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "ImportableRankingQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableRankingAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/RankingQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableScalePoint": { "required": [ "value" ], "type": "object", "properties": { "identifier": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" }, "imageFileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImportableScaleQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableScalePoint" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ScaleQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableSubQuestion": { "required": [ "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "title": { "minLength": 1, "type": "string" }, "referenceName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "ImportableText": { "required": [ "content", "cultureAlias", "masterCultureAlias" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/TextUiSettings" }, "cultureAlias": { "minLength": 1, "type": "string" }, "content": { "$ref": "#/components/schemas/MarkupText" } }, "additionalProperties": false }, "ImportableTextMatrixQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableSubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/QuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableTextMultipleFieldsQuestion": { "required": [ "cultureAlias", "masterCultureAlias", "title" ], "type": "object", "properties": { "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "masterCultureAlias": { "minLength": 1, "type": "string" }, "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportableTypedSubQuestion" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ImportableTypedSubQuestion": { "required": [ "title" ], "type": "object", "properties": { "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "identifier": { "minimum": 1, "type": "integer", "format": "int64" }, "title": { "minLength": 1, "type": "string" }, "referenceName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "InformationBarWidgetConfiguration": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "information": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "InheritedReportItemAnswerListUiSettings": { "type": "object", "properties": { "displayType": { "$ref": "#/components/schemas/AnswerListDisplayTypeInheritedProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintInheritedProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16InheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemChartUiSettings": { "type": "object", "properties": { "chartType": { "$ref": "#/components/schemas/ChartTypeInheritedProperty" }, "showLabels": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "legendType": { "$ref": "#/components/schemas/ChartLegendTypeInheritedProperty" }, "axisBoundsMin": { "$ref": "#/components/schemas/DoubleNullableInheritedProperty" }, "axisBoundsMax": { "$ref": "#/components/schemas/DoubleNullableInheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemColorPaletteUiSettings": { "type": "object", "properties": { "colorPaletteId": { "$ref": "#/components/schemas/Int64InheritedProperty" }, "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListInheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemDataTableTableUiSettings": { "type": "object", "properties": { "displayType": { "$ref": "#/components/schemas/ReportItemDataTableTableDisplayTypeInheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemDataTableUiSettings": { "type": "object", "properties": { "tableSettings": { "$ref": "#/components/schemas/InheritedReportItemDataTableTableUiSettings" }, "chartType": { "$ref": "#/components/schemas/ChartTypeInheritedProperty" }, "chartValueFormat": { "$ref": "#/components/schemas/ChartValueFormatInheritedProperty" }, "percentageCalculationPolicy": { "$ref": "#/components/schemas/PercentageCalculationPolicyInheritedProperty" }, "showChartLabels": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "chartLegendType": { "$ref": "#/components/schemas/ChartLegendTypeInheritedProperty" }, "showAnswerCount": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showAnswerShare": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showAverageValue": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showModeValue": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showMedianValue": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showVarianceValue": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showStandardDeviationValue": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "chartAxisBoundsMin": { "$ref": "#/components/schemas/DoubleNullableInheritedProperty" }, "chartAxisBoundsMax": { "$ref": "#/components/schemas/DoubleNullableInheritedProperty" }, "reverseAlternatives": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "colorPaletteId": { "$ref": "#/components/schemas/Int64InheritedProperty" }, "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListInheritedProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintInheritedProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16InheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemIndexTableUiSettings": { "type": "object", "properties": { "showResponderCount": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "displayType": { "$ref": "#/components/schemas/ReportItemTableDisplayTypeInheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemIndexUiSettings": { "type": "object", "properties": { "chartSettings": { "$ref": "#/components/schemas/InheritedReportItemChartUiSettings" }, "tableSettings": { "$ref": "#/components/schemas/InheritedReportItemIndexTableUiSettings" }, "colorPalette": { "$ref": "#/components/schemas/InheritedReportItemColorPaletteUiSettings" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintInheritedProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16InheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemMatrixStatisticsChartUiSettings": { "type": "object", "properties": { "measureType": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsChartMeasureTypeInheritedProperty" }, "chartType": { "$ref": "#/components/schemas/ChartTypeInheritedProperty" }, "showLabels": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "legendType": { "$ref": "#/components/schemas/ChartLegendTypeInheritedProperty" }, "axisBoundsMin": { "$ref": "#/components/schemas/DoubleNullableInheritedProperty" }, "axisBoundsMax": { "$ref": "#/components/schemas/DoubleNullableInheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemMatrixStatisticsTableUiSettings": { "type": "object", "properties": { "measureLabelDisplayType": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTableMeasureLabelDisplayTypeInheritedProperty" }, "showResponderCount": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showAverageValue": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showModeValue": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showAggregatedAnswerCount": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showAggregatedAnswerShare": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showAnswerCount": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "showAnswerShare": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "displayType": { "$ref": "#/components/schemas/ReportItemTableDisplayTypeInheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemMatrixStatisticsUiSettings": { "type": "object", "properties": { "chartSettings": { "$ref": "#/components/schemas/InheritedReportItemMatrixStatisticsChartUiSettings" }, "tableSettings": { "$ref": "#/components/schemas/InheritedReportItemMatrixStatisticsTableUiSettings" }, "showTotal": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "reverseAggregatedAlternatives": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "colorPaletteId": { "$ref": "#/components/schemas/Int64InheritedProperty" }, "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListInheritedProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintInheritedProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16InheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemNpsUiSettings": { "type": "object", "properties": { "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListInheritedProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintInheritedProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16InheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemRankedDataTableUiSettings": { "type": "object", "properties": { "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintInheritedProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16InheritedProperty" } }, "additionalProperties": false }, "InheritedReportItemUiSettings": { "type": "object", "properties": { "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanInheritedProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintInheritedProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16InheritedProperty" } }, "additionalProperties": false }, "InheritedReportUiSettings": { "type": "object", "properties": { "cssClasses": { "$ref": "#/components/schemas/StringArrayInheritedProperty" }, "answerListDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemAnswerListUiSettings" }, "dataTableDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemDataTableUiSettings" }, "npsDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemNpsUiSettings" }, "rankedDataTableDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemRankedDataTableUiSettings" }, "textDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" }, "numberStatisticsDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" }, "indexDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemIndexUiSettings" }, "matrixStatisticsDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemMatrixStatisticsUiSettings" }, "responseRateDefaultUiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" } }, "additionalProperties": false }, "InitiatePasswordResetRequest": { "type": "object", "properties": { "appIdentifier": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InitiatePasswordResetStatus": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "additionalProperties": false }, "InitiateUserRequestStatus": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "additionalProperties": false }, "InputAnswerMetadata": { "type": "object", "properties": { "countryIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InputAnswerMetadataServiceModel": { "type": "object", "properties": { "country": { "$ref": "#/components/schemas/Country" } }, "additionalProperties": false }, "InputQuestion": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "InputQuestionAnswer": { "type": "object", "properties": { "value": { "nullable": true }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "metadata": { "$ref": "#/components/schemas/InputAnswerMetadataServiceModel" }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "InputQuestionUiSettings": { "type": "object", "properties": { "inputFieldType": { "$ref": "#/components/schemas/InputType" }, "allowCountrySelection": { "type": "boolean" }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "InputType": { "enum": [ "Undefined", "SingleLine", "MultiLine" ], "type": "string" }, "Int16IOptionalProperty": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32", "readOnly": true }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Int16InheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/Int16IOptionalProperty" }, "inheritedValue": { "type": "integer", "format": "int32" }, "calculatedValue": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Int16NullableOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Int16OptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Int64AggregationResponse": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Int64AggregationResponseAggregationBucketResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Int64AggregationResponse" }, "nullable": true } }, "additionalProperties": false }, "Int64IChangedValue": { "type": "object", "properties": { "oldValue": { "type": "integer", "format": "int64", "readOnly": true }, "newValue": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "Int64IOptionalProperty": { "type": "object", "properties": { "value": { "type": "integer", "format": "int64", "readOnly": true }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Int64InheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/Int64IOptionalProperty" }, "inheritedValue": { "type": "integer", "format": "int64" }, "calculatedValue": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "Int64NullableOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Int64OptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Int64PagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "InterimAnswerSaveMode": { "enum": [ "Disabled", "Manual", "Automatic" ], "type": "string" }, "InterimAnswerSaveModeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/InterimAnswerSaveMode" } }, "additionalProperties": false }, "InvalidationLogClearedResponse": { "type": "object", "properties": { "hash": { "type": "string", "nullable": true }, "removeCount": { "type": "integer", "format": "int32" }, "originCount": { "type": "integer", "format": "int32" }, "currentCount": { "type": "integer", "format": "int32" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/InvalidationLogEntry" }, "nullable": true } }, "additionalProperties": false }, "InvalidationLogClearedResponseNodeResponse": { "type": "object", "properties": { "node": { "type": "string", "nullable": true }, "object": { "$ref": "#/components/schemas/InvalidationLogClearedResponse" } }, "additionalProperties": false }, "InvalidationLogEntry": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "timestamp": { "type": "string", "format": "date-time" }, "keys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvalidationLogResponse": { "type": "object", "properties": { "entryCount": { "type": "integer", "format": "int32", "readOnly": true }, "hash": { "type": "string", "nullable": true }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/InvalidationLogEntry" }, "nullable": true } }, "additionalProperties": false }, "InvalidationLogResponseNodeResponse": { "type": "object", "properties": { "node": { "type": "string", "nullable": true }, "object": { "$ref": "#/components/schemas/InvalidationLogResponse" } }, "additionalProperties": false }, "LastSessionPropertyAggregationBucket": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/ResponderSessionAggregationProperty" }, "size": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "LocalizedContentImportContainer": { "required": [ "content", "cultureAlias" ], "type": "object", "properties": { "cultureAlias": { "minLength": 1, "type": "string" }, "content": { "$ref": "#/components/schemas/ContentImportContainer" } }, "additionalProperties": false }, "LocalizedStringTranslation": { "type": "object", "properties": { "cultureAlias": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LookupProperties": { "type": "object", "properties": { "lookup1": { "$ref": "#/components/schemas/LookupProperty" }, "lookup2": { "$ref": "#/components/schemas/LookupProperty" } }, "additionalProperties": false }, "LookupProperty": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/LookupPropertyType" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LookupPropertyType": { "enum": [ "Username", "Password" ], "type": "string" }, "LookupResponse": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true, "readOnly": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true }, "found": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MailCountersRangeFilters": { "type": "object", "properties": { "sentForDelivery": { "$ref": "#/components/schemas/Range" }, "deliveryFailure": { "$ref": "#/components/schemas/Range" }, "bounced": { "$ref": "#/components/schemas/Range" } }, "additionalProperties": false }, "MailStatusCounter": { "type": "object", "properties": { "sentForDeliveryCount": { "type": "integer", "format": "int64" }, "bounceCount": { "type": "integer", "format": "int64" }, "deliveryFailureCount": { "type": "integer", "format": "int64" }, "successCount": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "successShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "bounceShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "deliveryFailureShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "MailTransactionCounters": { "type": "object", "properties": { "fieldPeriodId": { "type": "integer", "format": "int64" }, "sentForDelivery": { "type": "integer", "format": "int32" }, "bounced": { "type": "integer", "format": "int32" }, "deliveryFailure": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MapAnswer": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/Coordinates" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "MapQuestion": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/MapQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "MapQuestionUiSettings": { "type": "object", "properties": { "initialPosition": { "$ref": "#/components/schemas/Coordinates" }, "initialZoom": { "type": "integer", "format": "int32" }, "size": { "$ref": "#/components/schemas/MapSize" }, "wmsLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "MapSize": { "enum": [ "Undefined", "Small", "Medium", "Large" ], "type": "string" }, "MarkupText": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TextMarkupType" }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MemoryCacheInvalidationResponse": { "type": "object", "properties": { "ok": { "type": "boolean" }, "distributeInvalidation": { "type": "boolean" } }, "additionalProperties": false }, "MemoryCacheInvalidationResponseNodeResponse": { "type": "object", "properties": { "node": { "type": "string", "nullable": true }, "object": { "$ref": "#/components/schemas/MemoryCacheInvalidationResponse" } }, "additionalProperties": false }, "MemoryCacheStatus": { "type": "object", "properties": { "keyCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "MemoryCacheStatusNodeResponse": { "type": "object", "properties": { "node": { "type": "string", "nullable": true }, "object": { "$ref": "#/components/schemas/MemoryCacheStatus" } }, "additionalProperties": false }, "MenuWidgetConfiguration": { "type": "object", "properties": { "links": { "type": "array", "items": { "$ref": "#/components/schemas/MenuWidgetMenuLink" }, "nullable": true } }, "additionalProperties": false }, "MenuWidgetLinkTarget": { "enum": [ "FieldPeriod", "ExternalUrl", "AppStart", "Undefined" ], "type": "string" }, "MenuWidgetMenuLink": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string", "nullable": true }, "target": { "$ref": "#/components/schemas/MenuWidgetLinkTarget" }, "fieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "fieldPeriodIdentifier": { "type": "string", "nullable": true }, "externalUrl": { "pattern": "^(http(s)?://)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\\/\\w \\.-]*)*\\/?$", "type": "string", "nullable": true } }, "additionalProperties": false }, "Message": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "batchId": { "type": "string", "nullable": true }, "sentForDeliveryUtc": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringKeyValuePair" }, "nullable": true } }, "additionalProperties": false }, "MessageDeliveryStatus": { "type": "object", "properties": { "batchId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MessageDistributionEvent": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "remoteId": { "type": "string", "nullable": true }, "messageId": { "type": "integer", "format": "int64" }, "responderGuid": { "type": "string", "nullable": true }, "eventType": { "$ref": "#/components/schemas/ResponderDistributionEventType" }, "timestampUtc": { "type": "string", "format": "date-time" }, "originTimestampUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MessageDistributionEventPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MessageDistributionEvent" }, "nullable": true } }, "additionalProperties": false }, "MessagePagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Message" }, "nullable": true } }, "additionalProperties": false }, "MoveContentInstanceInstructions": { "required": [ "contentInstanceUris", "contextType", "targetContentInstanceUri" ], "type": "object", "properties": { "targetContentInstanceUri": { "type": "string", "format": "uri" }, "contextType": { "$ref": "#/components/schemas/ContentStructureContext" }, "contextId": { "type": "integer", "format": "int64" }, "contentInstanceUris": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "additionalProperties": false }, "MultiTerms": { "type": "object", "properties": { "terms": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "MutableDataSetProviderSetting": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "NewActivity": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NewAppUserLogin": { "required": [ "password" ], "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "appIdentifier": { "type": "string", "nullable": true }, "password": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NewBase64FileRequest": { "required": [ "base64String", "contentType", "fileName" ], "type": "object", "properties": { "base64String": { "minLength": 1, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "contentType": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NewColorPalette": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "hexColors": { "pattern": "^#[A-Fa-f0-9]{6}$", "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "NewContentFilterEntry": { "required": [ "contentId", "contentInstanceId", "contentInstanceUri" ], "type": "object", "properties": { "groupIdentifier": { "type": "string", "format": "uuid", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "minLength": 1, "type": "string" }, "operator": { "$ref": "#/components/schemas/ContentFilterOperator" }, "subQuestionId": { "type": "integer", "format": "int64", "nullable": true }, "alternativeId": { "type": "integer", "format": "int64", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewCostCenter": { "required": [ "companyName", "name", "organizationNumber" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "overdraftLimit": { "type": "number", "format": "double", "nullable": true }, "companyName": { "minLength": 1, "type": "string" }, "organizationNumber": { "minLength": 1, "type": "string" }, "vatNumber": { "type": "string", "nullable": true }, "invoiceAddress": { "type": "string", "nullable": true }, "invoicePostalCode": { "type": "string", "nullable": true }, "invoiceCity": { "type": "string", "nullable": true }, "invoiceCountry": { "type": "string", "nullable": true }, "invoiceReferenceNumber": { "type": "string", "nullable": true }, "invoiceEmail": { "type": "string", "nullable": true }, "contactFullName": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "contactPhoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewCrossTabulationInstructions": { "required": [ "cultureAlias", "dataSourceGuid", "reportItemId" ], "type": "object", "properties": { "reportItemId": { "type": "integer", "format": "int64" }, "cultureAlias": { "minLength": 1, "type": "string" }, "dataSourceGuid": { "type": "string", "format": "uuid" }, "dataScope": { "$ref": "#/components/schemas/ReportDataSeriesDataScope" } }, "additionalProperties": false }, "NewDataSeries": { "required": [ "cultureAlias", "name", "reportDataSourceGuid" ], "type": "object", "properties": { "reportDataSourceGuid": { "type": "string", "format": "uuid" }, "name": { "minLength": 1, "type": "string" }, "filterGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataScope": { "$ref": "#/components/schemas/ReportDataSeriesDataScope" }, "basedOnDataSeriesId": { "type": "integer", "format": "int64", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "uiSettings": { "$ref": "#/components/schemas/ReportDataSeriesUiSettings" }, "onlyFinished": { "type": "boolean", "nullable": true }, "onlyFinishedAfter": { "type": "string", "format": "date-time", "nullable": true }, "onlyFinishedBefore": { "type": "string", "format": "date-time", "nullable": true }, "includeTestResponders": { "type": "boolean", "nullable": true }, "includeInactiveResponders": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "NewDataSource": { "required": [ "fieldPeriodId", "name" ], "type": "object", "properties": { "fieldPeriodId": { "type": "integer", "format": "int64" }, "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NewEntityPermission": { "required": [ "sourceId", "targetId" ], "type": "object", "properties": { "sourceType": { "$ref": "#/components/schemas/EntityPermissionSourceType" }, "sourceId": { "minimum": 1, "type": "integer", "format": "int64" }, "targetType": { "$ref": "#/components/schemas/EntityPermissionTargetType" }, "targetId": { "minimum": 1, "type": "integer", "format": "int64" }, "access": { "$ref": "#/components/schemas/AclType" }, "allowInheritanceForTeams": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "NewFieldPeriodMessage": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "distributionType": { "$ref": "#/components/schemas/ResponderDistributionType" }, "cultureAlias": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "body": { "$ref": "#/components/schemas/MarkupText" } }, "additionalProperties": false }, "NewFieldPeriodMessageDistribution": { "type": "object", "properties": { "distributionType": { "$ref": "#/components/schemas/ResponderDistributionType" }, "senderFriendlyName": { "type": "string", "nullable": true }, "receiverMetadataId": { "type": "integer", "format": "int64" }, "responderQuery": { "$ref": "#/components/schemas/ResponderQuery" }, "costCenterId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "NewFieldPeriodResponderAuthProvider": { "required": [ "authProviderId", "autoProvisioning" ], "type": "object", "properties": { "authProviderId": { "type": "integer", "format": "int64" }, "costCenterId": { "type": "integer", "format": "int64", "nullable": true }, "autoProvisioning": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProviderMappingField" }, "nullable": true }, "autoProvisionMappings": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProviderAutoProvisionMappingField" }, "nullable": true } }, "additionalProperties": false }, "NewReport": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "documentExportTemplateFileName": { "type": "string", "format": "uuid", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true }, "relationship": { "$ref": "#/components/schemas/ReportRelationship" }, "includeNumberingInTitles": { "type": "boolean", "nullable": true }, "onlyFinished": { "type": "boolean", "nullable": true }, "onlyFinishedAfter": { "type": "string", "format": "date-time", "nullable": true }, "onlyFinishedBefore": { "type": "string", "format": "date-time", "nullable": true }, "includeTestResponders": { "type": "boolean", "nullable": true }, "includeInactiveResponders": { "type": "boolean", "nullable": true }, "respondersAreAnonymous": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionalReportUiSettings" } }, "additionalProperties": false }, "NewReportItemFilterEntries": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/NewReportItemFilterEntry" }, "nullable": true } }, "additionalProperties": false }, "NewReportItemFilterEntry": { "required": [ "reportItemId" ], "type": "object", "properties": { "groupIdentifier": { "type": "string", "format": "uuid", "nullable": true }, "reportItemId": { "type": "integer", "format": "int64" }, "operator": { "$ref": "#/components/schemas/ReportItemFilterOperator" }, "reportItemAlternativeId": { "type": "integer", "format": "int64", "nullable": true }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewReportSegmentingBreakPoint": { "required": [ "reportItemId" ], "type": "object", "properties": { "reportItemId": { "type": "integer", "format": "int64" }, "segmentVisibilityType": { "$ref": "#/components/schemas/ReportSegmentVisibilityType" } }, "additionalProperties": false }, "NewReportSegmentingInstructions": { "required": [ "cultureAlias", "dataSourceGuid", "orderedBreakPoints" ], "type": "object", "properties": { "deleteExistingSegments": { "type": "boolean" }, "cultureAlias": { "minLength": 1, "type": "string" }, "dataSourceGuid": { "type": "string", "format": "uuid" }, "orderedBreakPoints": { "type": "array", "items": { "$ref": "#/components/schemas/NewReportSegmentingBreakPoint" } }, "filterDataSource": { "$ref": "#/components/schemas/SegmentFilterDataSource" }, "initialFilterGuid": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "NewResponderApp": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "cultureAlias": { "minLength": 1, "type": "string" }, "entryFieldPeriodId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "NewResponderAppWidget": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/WidgetType" }, "menuWidget": { "$ref": "#/components/schemas/MenuWidgetConfiguration" }, "formListWidget": { "$ref": "#/components/schemas/FormListWidgetConfiguration" }, "informationBarWidget": { "$ref": "#/components/schemas/InformationBarWidgetConfiguration" }, "cultureAlias": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NewResponderAuthProvider": { "required": [ "mappingDefinition", "name", "scheme" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "scheme": { "minLength": 1, "type": "string" }, "autoProvisioningCapability": { "type": "boolean" }, "authCreditCost": { "type": "number", "format": "double" }, "mappingDefinition": { "$ref": "#/components/schemas/ResponderAuthProviderMappingDefinition" }, "autoProvisionMappingDefinition": { "$ref": "#/components/schemas/ResponderAuthProviderAutoProvisionMappingDefinition" } }, "additionalProperties": false }, "NewServiceServiceUserLogin": { "required": [ "password" ], "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NewSupportRequest": { "required": [ "message", "title" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string" }, "message": { "minLength": 1, "type": "string" }, "issueType": { "$ref": "#/components/schemas/SupportIssueType" }, "severityLevel": { "$ref": "#/components/schemas/SupportSeverityLevel" }, "supportAssistanceTargetEntity": { "$ref": "#/components/schemas/SupportAssistanceTargetEntity" }, "clientParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SupportRequestClientParameter" }, "nullable": true } }, "additionalProperties": false }, "NewSupportTeamAssistanceTarget": { "required": [ "targetId" ], "type": "object", "properties": { "targetType": { "$ref": "#/components/schemas/EntityPermissionTargetType" }, "targetId": { "minimum": 1, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "NewUser": { "required": [ "cultureAlias", "email" ], "type": "object", "properties": { "isServiceUser": { "type": "boolean" }, "email": { "minLength": 1, "pattern": "^[-0-9a-zA-ZäöåÄÖÅ.+_]+@[-0-9a-zA-ZäöåÄÖÅ.+_]+\\.[a-zA-Z]{2,63}$", "type": "string" }, "username": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "firstname": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "lastname": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "cellphone": { "pattern": "^(\\+|00)([1-9]{1}[0-9]{1}?).(\\d{5,})$", "type": "string", "nullable": true }, "description": { "maxLength": 1024, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "pattern": "^[a-z]{2,3}(-[A-Z]{2})*", "type": "string" }, "status": { "$ref": "#/components/schemas/UserStatus" }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureClaim" }, "nullable": true }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "propertyBag": { "$ref": "#/components/schemas/UserPropertyBag" } }, "additionalProperties": false }, "NewUserOtpLogin": { "required": [ "password" ], "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "minLength": 1, "type": "string" }, "deviceToken": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewUserRequest": { "required": [ "cultureAlias" ], "type": "object", "properties": { "source": { "$ref": "#/components/schemas/UserRequestSource" }, "cultureAlias": { "minLength": 1, "pattern": "^[a-z]{2,3}(-[A-Z]{2})*", "type": "string" }, "email": { "pattern": "^[-0-9a-zA-ZäöåÄÖÅ.+_]+@[-0-9a-zA-ZäöåÄÖÅ.+_]+\\.[a-zA-Z]{2,63}$", "type": "string", "nullable": true }, "password": { "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@#$%^&+=_\\-!¡?()\\[\\]{}\\\\|;:',.<>\\/*`~€¥£₹•√π÷׶∆£¢€¥^°=§±]).{6,}$", "type": "string", "nullable": true }, "description": { "maxLength": 1024, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "OptionMatrixQuestion": { "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/SubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/Alternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionMatrixQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OptionMatrixQuestionAnswer": { "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OptionMatrixSubQuestionAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "OptionMatrixQuestionUiSettings": { "type": "object", "properties": { "displayType": { "$ref": "#/components/schemas/OptionQuestionDisplayType" }, "buttonType": { "$ref": "#/components/schemas/ButtonType" }, "randomizeSubQuestions": { "type": "boolean" }, "randomizeAlternatives": { "type": "boolean" }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OptionMatrixSubQuestionAnswer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/AlternativeAnswer" }, "nullable": true } }, "additionalProperties": false }, "OptionQuestion": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/Alternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OptionQuestionAnswer": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/AlternativeAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "OptionQuestionDisplayType": { "enum": [ "Default", "AlwaysHorizontal", "AlwaysVertical", "Dropdown", "FilterableDropdown" ], "type": "string" }, "OptionQuestionTemplate": { "enum": [ "Undefined", "None", "Nps" ], "type": "string" }, "OptionQuestionUiSettings": { "type": "object", "properties": { "displayType": { "$ref": "#/components/schemas/OptionQuestionDisplayType" }, "buttonType": { "$ref": "#/components/schemas/ButtonType" }, "questionTemplate": { "$ref": "#/components/schemas/OptionQuestionTemplate" }, "randomizeAlternatives": { "type": "boolean" }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OptionalReportItemAnswerListUiSettings": { "type": "object", "properties": { "displayType": { "$ref": "#/components/schemas/AnswerListDisplayTypeOptionalProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintOptionalProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16OptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemChartUiSettings": { "type": "object", "properties": { "chartType": { "$ref": "#/components/schemas/ChartTypeOptionalProperty" }, "showLabels": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "legendType": { "$ref": "#/components/schemas/ChartLegendTypeOptionalProperty" }, "axisBoundsMin": { "$ref": "#/components/schemas/DoubleNullableOptionalProperty" }, "axisBoundsMax": { "$ref": "#/components/schemas/DoubleNullableOptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemColorPaletteUiSettings": { "type": "object", "properties": { "colorPaletteId": { "$ref": "#/components/schemas/Int64OptionalProperty" }, "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListOptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemDataTableTableUiSettings": { "type": "object", "properties": { "displayType": { "$ref": "#/components/schemas/ReportItemDataTableTableDisplayTypeOptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemDataTableUiSettings": { "type": "object", "properties": { "tableSettings": { "$ref": "#/components/schemas/OptionalReportItemDataTableTableUiSettings" }, "chartType": { "$ref": "#/components/schemas/ChartTypeOptionalProperty" }, "chartValueFormat": { "$ref": "#/components/schemas/ChartValueFormatOptionalProperty" }, "percentageCalculationPolicy": { "$ref": "#/components/schemas/PercentageCalculationPolicyOptionalProperty" }, "showChartLabels": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "chartLegendType": { "$ref": "#/components/schemas/ChartLegendTypeOptionalProperty" }, "showAnswerCount": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showAnswerShare": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showAverageValue": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showModeValue": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showMedianValue": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showVarianceValue": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showStandardDeviationValue": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "chartAxisBoundsMin": { "$ref": "#/components/schemas/DoubleNullableOptionalProperty" }, "chartAxisBoundsMax": { "$ref": "#/components/schemas/DoubleNullableOptionalProperty" }, "reverseAlternatives": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "colorPaletteId": { "$ref": "#/components/schemas/Int64OptionalProperty" }, "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListOptionalProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintOptionalProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16OptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemIndexTableUiSettings": { "type": "object", "properties": { "showResponderCount": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "displayType": { "$ref": "#/components/schemas/ReportItemTableDisplayTypeOptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemIndexUiSettings": { "type": "object", "properties": { "chartSettings": { "$ref": "#/components/schemas/OptionalReportItemChartUiSettings" }, "tableSettings": { "$ref": "#/components/schemas/OptionalReportItemIndexTableUiSettings" }, "colorPalette": { "$ref": "#/components/schemas/OptionalReportItemColorPaletteUiSettings" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintOptionalProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16OptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemMatrixStatisticsChartUiSettings": { "type": "object", "properties": { "measureType": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsChartMeasureTypeOptionalProperty" }, "chartType": { "$ref": "#/components/schemas/ChartTypeOptionalProperty" }, "showLabels": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "legendType": { "$ref": "#/components/schemas/ChartLegendTypeOptionalProperty" }, "axisBoundsMin": { "$ref": "#/components/schemas/DoubleNullableOptionalProperty" }, "axisBoundsMax": { "$ref": "#/components/schemas/DoubleNullableOptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemMatrixStatisticsTableUiSettings": { "type": "object", "properties": { "measureLabelDisplayType": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTableMeasureLabelDisplayTypeOptionalProperty" }, "showResponderCount": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showAverageValue": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showModeValue": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showAggregatedAnswerCount": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showAggregatedAnswerShare": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showAnswerCount": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "showAnswerShare": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "displayType": { "$ref": "#/components/schemas/ReportItemTableDisplayTypeOptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemMatrixStatisticsUiSettings": { "type": "object", "properties": { "chartSettings": { "$ref": "#/components/schemas/OptionalReportItemMatrixStatisticsChartUiSettings" }, "tableSettings": { "$ref": "#/components/schemas/OptionalReportItemMatrixStatisticsTableUiSettings" }, "showTotal": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "reverseAggregatedAlternatives": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "colorPaletteId": { "$ref": "#/components/schemas/Int64OptionalProperty" }, "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListOptionalProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintOptionalProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16OptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemNpsUiSettings": { "type": "object", "properties": { "colorPaletteHexColors": { "$ref": "#/components/schemas/StringListOptionalProperty" }, "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintOptionalProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16OptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemRankedDataTableUiSettings": { "type": "object", "properties": { "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintOptionalProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16OptionalProperty" } }, "additionalProperties": false }, "OptionalReportItemUiSettings": { "type": "object", "properties": { "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "isHidden": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "dataSourceHint": { "$ref": "#/components/schemas/ReportItemDataSourceHintOptionalProperty" }, "decimalPrecision": { "$ref": "#/components/schemas/Int16OptionalProperty" } }, "additionalProperties": false }, "OptionalReportUiSettings": { "type": "object", "properties": { "cssClasses": { "$ref": "#/components/schemas/StringArrayOptionalProperty" }, "answerListDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemAnswerListUiSettings" }, "dataTableDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemDataTableUiSettings" }, "npsDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemNpsUiSettings" }, "rankedDataTableDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemRankedDataTableUiSettings" }, "textDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemUiSettings" }, "numberStatisticsDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemUiSettings" }, "indexDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemIndexUiSettings" }, "matrixStatisticsDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemMatrixStatisticsUiSettings" }, "responseRateDefaultUiSettings": { "$ref": "#/components/schemas/OptionalReportItemUiSettings" } }, "additionalProperties": false }, "OrderByField": { "enum": [ "Undefined", "Id" ], "type": "string" }, "OtpResponse": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "deviceTrusted": { "type": "boolean" } }, "additionalProperties": false }, "OtpVerificationResponse": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "deviceToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PatchInstructions": { "type": "object", "properties": { "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "PatchResponderSessionRequest": { "type": "object", "properties": { "cultureAlias": { "$ref": "#/components/schemas/StringOptionalRequestProperty" } }, "additionalProperties": false }, "PercentageCalculationPolicy": { "enum": [ "Undefined", "ResponderBased", "AnswerBased" ], "type": "string" }, "PercentageCalculationPolicyIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/PercentageCalculationPolicy" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PercentageCalculationPolicyInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/PercentageCalculationPolicyIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/PercentageCalculationPolicy" }, "calculatedValue": { "$ref": "#/components/schemas/PercentageCalculationPolicy" } }, "additionalProperties": false }, "PercentageCalculationPolicyOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/PercentageCalculationPolicy" } }, "additionalProperties": false }, "Permission": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "sourceType": { "$ref": "#/components/schemas/EntityPermissionSourceType" }, "sourceId": { "type": "integer", "format": "int64" }, "access": { "$ref": "#/components/schemas/AclType" }, "sourceName": { "type": "string", "nullable": true }, "direct": { "type": "boolean" }, "allowInheritanceForTeams": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PermissionPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" }, "nullable": true } }, "additionalProperties": false }, "PermissionRestrictionFilter": { "enum": [ "All", "OwnedEntities", "DirectlyShared" ], "type": "string" }, "QuestionType": { "enum": [ "Undefined", "Option", "OptionMatrix", "Ranked", "TextMatrix", "TextMultipleFields", "Input", "AreaSegmenter", "AreaRepeater", "File", "Canvas", "Map", "Scale", "DataSetTypeAhead" ], "type": "string" }, "QuestionUiSettings": { "type": "object", "properties": { "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Range": { "type": "object", "properties": { "min": { "type": "integer", "format": "int64" }, "max": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "RankedAlternativeAnswer": { "type": "object", "properties": { "sortOrder": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "customValue": { "nullable": true }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" } }, "additionalProperties": false }, "RankingAlternative": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFile": { "$ref": "#/components/schemas/FileWithPublicUrl" }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "RankingQuestion": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/RankingAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/RankingQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "RankingQuestionAnswer": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/RankedAlternativeAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "RankingQuestionUiSettings": { "type": "object", "properties": { "randomizeAlternatives": { "type": "boolean" }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Receipt": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReceiptEventConfiguration": { "type": "object", "properties": { "recipientAddress": { "type": "string", "nullable": true }, "fieldPeriodMessageId": { "type": "integer", "format": "int64", "nullable": true }, "senderFriendlyName": { "type": "string", "nullable": true }, "excludeQuestionsWillEmptyAnswers": { "type": "boolean", "nullable": true }, "resolvers": { "type": "array", "items": { "$ref": "#/components/schemas/EventConfigurationValueResolverConfiguration" }, "nullable": true } }, "additionalProperties": false }, "RedirectDelayType": { "enum": [ "Direct", "ThreeSeconds", "FiveSeconds", "TenSeconds", "FifteenSeconds" ], "type": "string" }, "Report": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "activityId": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string", "nullable": true }, "documentExportTemplateFile": { "$ref": "#/components/schemas/FileWithPublicUrl" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "preferredCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "responderQueryRestrictions": { "$ref": "#/components/schemas/IResponderQueryRestrictions" }, "respondersAreAnonymous": { "type": "boolean" }, "uiSettings": { "$ref": "#/components/schemas/InheritedReportUiSettings" } }, "additionalProperties": false }, "ReportAggregatedAlternativeItemStatistics": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "alternativeIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "answerCount": { "type": "integer", "format": "int64" }, "answerShare": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportAlternativeCollectionIndexValue": { "type": "object", "properties": { "alternativeCollectionId": { "type": "integer", "format": "int64", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "responderCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ReportAlternativeCollectionStatistics": { "type": "object", "properties": { "alternativeCollectionId": { "type": "integer", "format": "int64", "nullable": true }, "aggregatedAlternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ReportAggregatedAlternativeItemStatistics" }, "nullable": true }, "statisticMeasures": { "$ref": "#/components/schemas/IStatisticMeasures" }, "responderCount": { "type": "integer", "format": "int64", "nullable": true }, "aggregatedAnswerCount": { "type": "integer", "format": "int64" }, "aggregatedAnswerShare": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportAlternativeItemStatistics": { "type": "object", "properties": { "alternativeId": { "type": "integer", "format": "int64" }, "answerCount": { "type": "integer", "format": "int64" }, "answerShare": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportAnswerCoordinatesItem": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/ICoordinates" }, "nullable": true }, "googleMapsLink": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ReportAnswerFileItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contentLength": { "type": "integer", "format": "int64" }, "contentType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "originalName": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "uploaderUserId": { "type": "integer", "format": "int64" }, "uploaded": { "type": "string", "format": "date-time" }, "fileStorageType": { "$ref": "#/components/schemas/FileStorageType" }, "requirePermissionCheck": { "type": "boolean", "nullable": true }, "fileFormat": { "$ref": "#/components/schemas/FileFormat" } }, "additionalProperties": false }, "ReportAnswerList": { "type": "object", "properties": { "dataSeriesId": { "type": "integer", "format": "int64" }, "itemId": { "type": "integer", "format": "int64" }, "items": { "$ref": "#/components/schemas/ReportAnswerListItemPagedList" }, "anonymousIntegrityStatus": { "$ref": "#/components/schemas/ResponderIntegrityGuardStatus" } }, "additionalProperties": false }, "ReportAnswerListItem": { "type": "object", "properties": { "responderIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "inputValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "inputValue": { "nullable": true, "readOnly": true }, "fileValue": { "$ref": "#/components/schemas/ReportAnswerFileItem" }, "coordinatesValue": { "$ref": "#/components/schemas/ReportAnswerCoordinatesItem" } }, "additionalProperties": false }, "ReportAnswerListItemPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportAnswerListItem" }, "nullable": true } }, "additionalProperties": false }, "ReportCrossTabulationCalculation": { "type": "object", "properties": { "totalNbrOrSeries": { "type": "integer", "format": "int64" }, "series": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReportDataSeries": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reportId": { "type": "integer", "format": "int64" }, "reportDataSourceGuid": { "type": "string", "format": "uuid" }, "filterGuid": { "type": "string", "format": "uuid", "nullable": true }, "reportSegmentGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataScope": { "$ref": "#/components/schemas/ReportDataSeriesDataScope" }, "basedOnDataSeriesId": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "responderQueryRestrictions": { "$ref": "#/components/schemas/IResponderQueryRestrictions" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "uiSettings": { "$ref": "#/components/schemas/ReportDataSeriesUiSettings" } }, "additionalProperties": false }, "ReportDataSeriesDataScope": { "enum": [ "Report", "ReportSegment" ], "type": "string" }, "ReportDataSeriesPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDataSeries" }, "nullable": true } }, "additionalProperties": false }, "ReportDataSeriesSortOrder": { "type": "object", "properties": { "dataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataScope": { "$ref": "#/components/schemas/ReportDataSeriesDataScope" } }, "additionalProperties": false }, "ReportDataSeriesUiSettings": { "type": "object", "properties": { "isHiddenForUi": { "type": "boolean" }, "isHiddenForExport": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReportDataSource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "guid": { "type": "string", "format": "uuid" }, "reportId": { "type": "integer", "format": "int64" }, "fieldPeriodId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ReportDataSourcePagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDataSource" }, "nullable": true } }, "additionalProperties": false }, "ReportDataTableStatistics": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ReportAlternativeItemStatistics" }, "nullable": true }, "statisticMeasures": { "$ref": "#/components/schemas/IStatisticMeasures" } }, "additionalProperties": false }, "ReportExport": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "reportId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "reportCount": { "type": "integer", "format": "int32" }, "url": { "type": "string", "nullable": true }, "fileType": { "$ref": "#/components/schemas/FileType" }, "isArchive": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ReportExtended": { "type": "object", "properties": { "formName": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int64" }, "activityId": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string", "nullable": true }, "documentExportTemplateFile": { "$ref": "#/components/schemas/FileWithPublicUrl" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "preferredCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "responderQueryRestrictions": { "$ref": "#/components/schemas/IResponderQueryRestrictions" }, "respondersAreAnonymous": { "type": "boolean" }, "uiSettings": { "$ref": "#/components/schemas/InheritedReportUiSettings" } }, "additionalProperties": false }, "ReportExtendedPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportExtended" }, "nullable": true } }, "additionalProperties": false }, "ReportIndexStatistics": { "type": "object", "properties": { "alternativeCollections": { "type": "array", "items": { "$ref": "#/components/schemas/ReportAlternativeCollectionIndexValue" }, "nullable": true } }, "additionalProperties": false }, "ReportItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "type": { "$ref": "#/components/schemas/ReportItemType" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "isSegmentable": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" }, "dataTableConfig": { "$ref": "#/components/schemas/ReportItemDataTableTypeConfig" }, "matrixStatisticsConfig": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTypeConfig" }, "rankedDataTableConfig": { "$ref": "#/components/schemas/ReportItemRankedDataTableTypeConfig" }, "textConfig": { "$ref": "#/components/schemas/ReportItemTextTypeConfig" }, "answerListConfig": { "$ref": "#/components/schemas/ReportItemAnswerListTypeConfig" }, "numberStatisticsConfig": { "$ref": "#/components/schemas/ReportItemNumberStatisticsTypeConfig" }, "npsConfig": { "$ref": "#/components/schemas/ReportItemNpsTypeConfig" }, "indexConfig": { "$ref": "#/components/schemas/ReportItemIndexTypeConfig" }, "responseRateConfig": { "$ref": "#/components/schemas/ReportItemResponseRateTypeConfig" } }, "additionalProperties": false }, "ReportItemAggregatedAlternative": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "statisticMeasureWeight": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ReportItemAlternative": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "guid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ReportItemAlternativeType" }, "statisticMeasureWeight": { "type": "number", "format": "double", "nullable": true }, "percentageBaseGroup": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ReportItemAlternativeCollection": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "aggregatedAlternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemAggregatedAlternative" }, "nullable": true } }, "additionalProperties": false }, "ReportItemAlternativeGroup": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ReportItemAlternativeType" }, "name": { "type": "string", "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemAlternative" }, "nullable": true } }, "additionalProperties": false }, "ReportItemAlternativeType": { "enum": [ "Regular", "Nps", "Undefined" ], "type": "string" }, "ReportItemAnswerListTypeConfig": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" } }, "additionalProperties": false }, "ReportItemCompositeStatistics": { "type": "object", "properties": { "dataSeriesId": { "type": "integer", "format": "int64" }, "itemId": { "type": "integer", "format": "int64" }, "responderCount": { "type": "integer", "format": "int64" }, "dataTableStatistics": { "$ref": "#/components/schemas/ReportDataTableStatistics" }, "matrixStatistics": { "$ref": "#/components/schemas/ReportMatrixStatistics" }, "rankedDataTableStatistics": { "$ref": "#/components/schemas/ReportRankedDataTableStatistics" }, "npsStatistics": { "$ref": "#/components/schemas/ReportNpsStatistics" }, "numberStatistics": { "$ref": "#/components/schemas/ReportNumberStatistics" }, "indexStatistics": { "$ref": "#/components/schemas/ReportIndexStatistics" }, "responseRateStatistics": { "$ref": "#/components/schemas/ReportResponseRateStatistics" }, "anonymousIntegrityStatus": { "$ref": "#/components/schemas/ResponderIntegrityGuardStatus" } }, "additionalProperties": false }, "ReportItemDataSeriesScope": { "enum": [ "All", "Report", "CurrentAndInheritedSegments", "CurrentSegment", "InheritedSegments" ], "type": "string" }, "ReportItemDataSourceHint": { "enum": [ "Content", "ResponderData", "Undefined" ], "type": "string" }, "ReportItemDataSourceHintIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemDataSourceHint" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ReportItemDataSourceHintInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemDataSourceHintIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ReportItemDataSourceHint" }, "calculatedValue": { "$ref": "#/components/schemas/ReportItemDataSourceHint" } }, "additionalProperties": false }, "ReportItemDataSourceHintOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ReportItemDataSourceHint" } }, "additionalProperties": false }, "ReportItemDataTableTableDisplayType": { "enum": [ "Hidden", "Visible" ], "type": "string" }, "ReportItemDataTableTableDisplayTypeIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemDataTableTableDisplayType" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ReportItemDataTableTableDisplayTypeInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemDataTableTableDisplayTypeIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ReportItemDataTableTableDisplayType" }, "calculatedValue": { "$ref": "#/components/schemas/ReportItemDataTableTableDisplayType" } }, "additionalProperties": false }, "ReportItemDataTableTableDisplayTypeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ReportItemDataTableTableDisplayType" } }, "additionalProperties": false }, "ReportItemDataTableTypeConfig": { "type": "object", "properties": { "alternativeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemAlternativeGroup" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemDataTableUiSettings" } }, "additionalProperties": false }, "ReportItemFilterEntry": { "type": "object", "properties": { "reportItemId": { "type": "integer", "format": "int64" }, "reportItemAlternativeId": { "type": "integer", "format": "int64", "nullable": true }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "value": { "nullable": true }, "id": { "type": "integer", "format": "int64", "readOnly": true }, "filterId": { "type": "integer", "format": "int64", "readOnly": true }, "filterGuid": { "type": "string", "format": "uuid", "readOnly": true }, "identifier": { "type": "string", "format": "uuid", "readOnly": true }, "groupIdentifier": { "type": "string", "format": "uuid", "readOnly": true } }, "additionalProperties": false }, "ReportItemFilterOperator": { "enum": [ "Undefined", "Equals", "NotEquals", "GreaterThan", "LessThan", "GreaterThanOrEquals", "LessThanOrEquals" ], "type": "string" }, "ReportItemHierarchyNode": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/ReportItem" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "ReportItemIHierarchyNode": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/ReportItem" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "ReportItemIndexType": { "enum": [ "AverageIndex", "ScbNkiIndex", "SkrHmeIndex" ], "type": "string" }, "ReportItemIndexTypeConfig": { "type": "object", "properties": { "alternativeCollections": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemAlternativeCollection" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemIndexUiSettings" } }, "additionalProperties": false }, "ReportItemMatrixStatisticsChartMeasureType": { "enum": [ "AggregatedAnswerCount", "AggregatedAnswerShare", "AnswerCount", "AnswerShare", "Average", "Mode", "ResponderCount" ], "type": "string" }, "ReportItemMatrixStatisticsChartMeasureTypeIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsChartMeasureType" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ReportItemMatrixStatisticsChartMeasureTypeInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsChartMeasureTypeIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsChartMeasureType" }, "calculatedValue": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsChartMeasureType" } }, "additionalProperties": false }, "ReportItemMatrixStatisticsChartMeasureTypeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsChartMeasureType" } }, "additionalProperties": false }, "ReportItemMatrixStatisticsTableMeasureLabelDisplayType": { "enum": [ "Auto", "Visible", "Hidden" ], "type": "string" }, "ReportItemMatrixStatisticsTableMeasureLabelDisplayTypeIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTableMeasureLabelDisplayType" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ReportItemMatrixStatisticsTableMeasureLabelDisplayTypeInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTableMeasureLabelDisplayTypeIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTableMeasureLabelDisplayType" }, "calculatedValue": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTableMeasureLabelDisplayType" } }, "additionalProperties": false }, "ReportItemMatrixStatisticsTableMeasureLabelDisplayTypeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ReportItemMatrixStatisticsTableMeasureLabelDisplayType" } }, "additionalProperties": false }, "ReportItemMatrixStatisticsTypeConfig": { "type": "object", "properties": { "alternativeCollections": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemAlternativeCollection" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" } }, "additionalProperties": false }, "ReportItemNpsTypeConfig": { "type": "object", "properties": { "alternativeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemAlternativeGroup" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemNpsUiSettings" } }, "additionalProperties": false }, "ReportItemNumberStatisticsTypeConfig": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" } }, "additionalProperties": false }, "ReportItemPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItem" }, "nullable": true } }, "additionalProperties": false }, "ReportItemRankedDataTableTypeConfig": { "type": "object", "properties": { "alternativeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemAlternativeGroup" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemRankedDataTableUiSettings" } }, "additionalProperties": false }, "ReportItemResponseRateTypeConfig": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" } }, "additionalProperties": false }, "ReportItemTableDisplayType": { "enum": [ "Hidden", "Vertical", "Horizontal" ], "type": "string" }, "ReportItemTableDisplayTypeIOptionalProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemTableDisplayType" }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ReportItemTableDisplayTypeInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ReportItemTableDisplayTypeIOptionalProperty" }, "inheritedValue": { "$ref": "#/components/schemas/ReportItemTableDisplayType" }, "calculatedValue": { "$ref": "#/components/schemas/ReportItemTableDisplayType" } }, "additionalProperties": false }, "ReportItemTableDisplayTypeOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "$ref": "#/components/schemas/ReportItemTableDisplayType" } }, "additionalProperties": false }, "ReportItemTextTypeConfig": { "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/InheritedReportItemUiSettings" } }, "additionalProperties": false }, "ReportItemType": { "enum": [ "Text", "DataTable", "AnswerList", "NumberStatistics", "Nps", "RankedDataTable", "MatrixStatistics", "ResponseRate", "AverageIndex", "ScbNkiIndex", "SkrHmeIndex", "Undefined" ], "type": "string" }, "ReportItemsSortOrder": { "type": "object", "properties": { "reportItemIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "ReportMatrixStatistics": { "type": "object", "properties": { "alternativeCollections": { "type": "array", "items": { "$ref": "#/components/schemas/ReportAlternativeCollectionStatistics" }, "nullable": true }, "statisticMeasures": { "$ref": "#/components/schemas/IStatisticMeasures" } }, "additionalProperties": false }, "ReportNpsStatistics": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ReportAlternativeItemStatistics" }, "nullable": true }, "statisticMeasures": { "$ref": "#/components/schemas/IStatisticMeasures" }, "npsScore": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ReportNumberStatistics": { "type": "object", "properties": { "numberStatistics": { "$ref": "#/components/schemas/INumberStatistics" } }, "additionalProperties": false }, "ReportOrderByField": { "enum": [ "Undefined", "Id", "Name" ], "type": "string" }, "ReportRankedAlternativeItemStatistics": { "type": "object", "properties": { "alternativeId": { "type": "integer", "format": "int64" }, "positionIndex": { "type": "integer", "format": "int64" }, "score": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ReportRankedDataTableStatistics": { "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/ReportRankedAlternativeItemStatistics" }, "nullable": true } }, "additionalProperties": false }, "ReportRelationship": { "type": "object", "properties": { "fieldPeriodId": { "type": "integer", "format": "int64" }, "names": { "$ref": "#/components/schemas/ReportRelationshipNames" } }, "additionalProperties": false }, "ReportRelationshipNames": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "dataSeries": { "type": "string", "nullable": true }, "responseRateItem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportResponseRateStatistics": { "type": "object", "properties": { "counters": { "$ref": "#/components/schemas/ResponderStateCounter" } }, "additionalProperties": false }, "ReportSegment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "reportId": { "type": "integer", "format": "int64", "readOnly": true }, "parentReportSegmentGuid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "ReportSegmentHierarchyNode": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/ReportSegment" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSegmentIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "ReportSegmentIHierarchyNode": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/ReportSegment" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSegmentIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "ReportSegmentVisibilityType": { "enum": [ "CurrentAndInherited", "Current", "Inherited", "Undefined" ], "type": "string" }, "ReportShare": { "type": "object", "properties": { "report": { "$ref": "#/components/schemas/Report" }, "segment": { "$ref": "#/components/schemas/ReportSegment" }, "dataSeries": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDataSeries" }, "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportItemHierarchyNode" }, "nullable": true }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSegmentHierarchyNode" }, "nullable": true }, "isExportable": { "type": "boolean" } }, "additionalProperties": false }, "ReportShareConfiguration": { "type": "object", "properties": { "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "isExportable": { "type": "boolean", "nullable": true }, "showSegments": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ResetUserPasswordRequest": { "required": [ "password" ], "type": "object", "properties": { "resetToken": { "type": "string", "format": "uuid" }, "password": { "minLength": 1, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@#$%^&+=_\\-!¡?()\\[\\]{}\\\\|;:',.<>\\/*`~€¥£₹•√π÷׶∆£¢€¥^°=§±]).{6,}$", "type": "string" } }, "additionalProperties": false }, "Responder": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "registryId": { "type": "integer", "format": "int64" }, "restrictedToFieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "guid": { "type": "string", "format": "uuid" }, "identifier": { "type": "string", "nullable": true }, "responderType": { "$ref": "#/components/schemas/ResponderType" }, "creationType": { "$ref": "#/components/schemas/ResponderCreationType" }, "optOutStatus": { "$ref": "#/components/schemas/ResponderOptOutStatus" }, "originResponderId": { "type": "integer", "format": "int64", "nullable": true }, "isActive": { "type": "boolean" }, "isUsedForTesting": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderData" }, "nullable": true }, "mailTransactionCounters": { "type": "array", "items": { "$ref": "#/components/schemas/MailTransactionCounters" }, "nullable": true }, "lastSessions": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderSession" }, "nullable": true } }, "additionalProperties": false }, "ResponderAggregationProperty": { "enum": [ "Undefined", "CreationType", "ResponderType", "IsActive", "IsUsedForTesting", "Belonging", "OptOutStatus" ], "type": "string" }, "ResponderAggregationQuery": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ResponderQuery" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderPropertyAggregationBucket" }, "nullable": true }, "lastSession": { "type": "array", "items": { "$ref": "#/components/schemas/LastSessionPropertyAggregationBucket" }, "nullable": true }, "dataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadataAggregationBucket" }, "nullable": true } }, "additionalProperties": false }, "ResponderAggregationResponse": { "type": "object", "properties": { "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Int64AggregationResponseAggregationBucketResponse" }, "nullable": true }, "lastSession": { "type": "array", "items": { "$ref": "#/components/schemas/Int64AggregationResponseAggregationBucketResponse" }, "nullable": true }, "dataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/Int64AggregationResponseAggregationBucketResponse" }, "nullable": true } }, "additionalProperties": false }, "ResponderApp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "identifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "preferredCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "entryFieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "entryFieldPeriodIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResponderAppSession": { "type": "object", "properties": { "responderFormSession": { "$ref": "#/components/schemas/ResponderFormSession" }, "responderApp": { "$ref": "#/components/schemas/ResponderApp" } }, "additionalProperties": false }, "ResponderAppWidget": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "responderAppId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/WidgetType" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "menuWidget": { "$ref": "#/components/schemas/MenuWidgetConfiguration" }, "formListWidget": { "$ref": "#/components/schemas/FormListWidgetConfiguration" }, "informationBarWidget": { "$ref": "#/components/schemas/InformationBarWidgetConfiguration" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ResponderAppWidgetPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderAppWidget" }, "nullable": true } }, "additionalProperties": false }, "ResponderAuthProvider": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "autoProvisioningCapability": { "type": "boolean" }, "authCreditCost": { "type": "number", "format": "double" }, "mappingDefinition": { "$ref": "#/components/schemas/IResponderAuthProviderMappingDefinition" }, "autoProvisionMappingDefinition": { "$ref": "#/components/schemas/IResponderAuthProviderAutoProvisionMappingDefinition" } }, "additionalProperties": false }, "ResponderAuthProviderAutoProvisionMappingDefinition": { "type": "object", "properties": { "mappingFields": { "type": "array", "items": { "$ref": "#/components/schemas/IResponderAuthProviderAutoProvisionMappingDefinitionField" }, "nullable": true } }, "additionalProperties": false }, "ResponderAuthProviderAutoProvisionMappingDefinitionClaim": { "enum": [ "Undefined", "Identifier", "Firstname", "Lastname", "Email" ], "type": "string" }, "ResponderAuthProviderIPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderAuthProvider" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ResponderAuthProviderMappingDefinition": { "type": "object", "properties": { "mappingFields": { "type": "array", "items": { "$ref": "#/components/schemas/IResponderAuthProviderMappingDefinitionField" }, "nullable": true } }, "additionalProperties": false }, "ResponderAuthProviderMappingDefinitionFieldIdentifier": { "enum": [ "Undefined", "Identifier", "Username", "Password" ], "type": "string" }, "ResponderAuthenticationPrice": { "type": "object", "properties": { "providerName": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ResponderAuthenticationPricePriceListWrapper": { "type": "object", "properties": { "validFrom": { "type": "string", "format": "date-time" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderAuthenticationPrice" }, "nullable": true } }, "additionalProperties": false }, "ResponderBackgroundImportResult": { "type": "object", "properties": { "importId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResponderBulkInsertError": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "failedAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ResponderBulkInsertStatus": { "enum": [ "Undefined", "Queued", "Failed", "Active", "Done" ], "type": "string" }, "ResponderCreationType": { "enum": [ "Undefined", "ManualByEditor", "FromDistributed", "ByPublicLink", "ByEditorialEvent", "ByResponderApp", "ByTestMode", "ByResponderAuth" ], "type": "string" }, "ResponderCurrentPreferences": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "isOptedOut": { "type": "boolean" } }, "additionalProperties": false }, "ResponderData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "metadataId": { "type": "integer", "format": "int64" }, "valueType": { "$ref": "#/components/schemas/ResponderDataMetadataType" }, "value": { "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "autoMapIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResponderDataFieldPeriodSettingType": { "enum": [ "Undefined", "ContentInstanceDefaultValue" ], "type": "string" }, "ResponderDataMetadata": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "valueType": { "$ref": "#/components/schemas/ResponderDataMetadataType" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ResponderDataMetadataUiSettings" }, "responderRegistryId": { "type": "integer", "format": "int64" }, "restrictedToFieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "autoMapIdentifier": { "type": "string", "nullable": true }, "autoRandomizeUniqueValue": { "type": "boolean", "nullable": true }, "useAsAlternativeResponderIdentifier": { "type": "boolean", "nullable": true }, "fieldPeriodSettings": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadataFieldPeriodSetting" }, "nullable": true } }, "additionalProperties": false }, "ResponderDataMetadataAggregationBucket": { "required": [ "identifier", "name" ], "type": "object", "properties": { "size": { "type": "integer", "format": "int32", "nullable": true }, "name": { "minLength": 1, "type": "string" }, "identifier": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ResponderDataMetadataFieldPeriodSetting": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "responderDataMetadataId": { "type": "integer", "format": "int64" }, "fieldPeriodId": { "type": "integer", "format": "int64" }, "settingType": { "$ref": "#/components/schemas/ResponderDataFieldPeriodSettingType" }, "formVersionId": { "type": "integer", "format": "int64", "nullable": true }, "valueString": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResponderDataMetadataPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadata" }, "nullable": true } }, "additionalProperties": false }, "ResponderDataMetadataRangeFilter": { "type": "object", "properties": { "identifier": { "type": "integer", "format": "int64" }, "range": { "$ref": "#/components/schemas/Range" } }, "additionalProperties": false }, "ResponderDataMetadataSortOrder": { "type": "object", "properties": { "sortOrder": { "$ref": "#/components/schemas/SortOrder" }, "identifier": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ResponderDataMetadataStatisticsBucket": { "required": [ "identifier", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "identifier": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ResponderDataMetadataTermsFilter": { "type": "object", "properties": { "identifier": { "type": "integer", "format": "int64" }, "terms": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ResponderDataMetadataType": { "enum": [ "Undefined", "String", "Number", "DateTime", "Email", "Telephone", "Culture" ], "type": "string" }, "ResponderDataMetadataUiSettings": { "type": "object", "properties": { "hideInResponderTable": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ResponderDataMetadataValueResolverConfiguration": { "type": "object", "properties": { "dataMetadataId": { "minimum": 1, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ResponderDistributionBatchTrigger": { "enum": [ "Manual", "OneTimeSchedule", "RecurringSchedule" ], "type": "string" }, "ResponderDistributionEventType": { "enum": [ "Undefined", "SentForDelivery", "DeliveryFailure", "Bounced" ], "type": "string" }, "ResponderDistributionType": { "enum": [ "Undefined", "Sms", "Email", "SchoolSoft" ], "type": "string" }, "ResponderFormSession": { "type": "object", "properties": { "responderSession": { "$ref": "#/components/schemas/ResponderSessionSummary" }, "form": { "$ref": "#/components/schemas/Form" }, "structure": { "$ref": "#/components/schemas/ContentInstanceStructure" }, "fieldPeriodUiSettings": { "$ref": "#/components/schemas/FieldPeriodUiSettings" }, "validators": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerValidator" }, "nullable": true }, "translations": { "type": "array", "items": { "$ref": "#/components/schemas/ITranslation" }, "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionTarget" }, "nullable": true }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentedAnswers" }, "nullable": true } }, "additionalProperties": false }, "ResponderImportColumnMapping": { "required": [ "fileColumnId", "metadataId" ], "type": "object", "properties": { "metadataId": { "type": "integer", "format": "int64" }, "fileColumnId": { "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResponderImportFile": { "type": "object", "properties": { "isImportTemplate": { "type": "boolean" }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/IResponderImportFileHeader" }, "nullable": true } }, "additionalProperties": false }, "ResponderImportFileValidationRequest": { "required": [ "columnMappings" ], "type": "object", "properties": { "registryId": { "type": "integer", "format": "int64" }, "fileName": { "type": "string", "format": "uuid" }, "columnMappings": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderImportValidationColumnMapping" } }, "timeZoneName": { "type": "string", "nullable": true }, "ignoreAnswerValidation": { "type": "boolean" } }, "additionalProperties": false }, "ResponderImportLogEntry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "guid": { "type": "string", "nullable": true }, "queuedBy": { "$ref": "#/components/schemas/FriendlyObjectIdentity" }, "fieldPeriod": { "$ref": "#/components/schemas/FriendlyObjectIdentity" }, "importFile": { "$ref": "#/components/schemas/FriendlyObjectIdentity" }, "responderRegistry": { "$ref": "#/components/schemas/FriendlyObjectIdentity" }, "retryCount": { "type": "integer", "format": "int32" }, "retriesLeft": { "type": "integer", "format": "int32", "readOnly": true }, "queuedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "startedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "doneAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/ResponderBulkInsertStatus" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderBulkInsertError" }, "nullable": true } }, "additionalProperties": false }, "ResponderImportLogEntryPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderImportLogEntry" }, "nullable": true } }, "additionalProperties": false }, "ResponderImportLogEntryStatusAggregation": { "type": "object", "properties": { "queued": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "active": { "type": "integer", "format": "int32" }, "done": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResponderImportRequest": { "required": [ "columnMappings" ], "type": "object", "properties": { "registryId": { "type": "integer", "format": "int64" }, "responderType": { "$ref": "#/components/schemas/ResponderType" }, "isUsedForTesting": { "type": "boolean" }, "fileName": { "type": "string", "format": "uuid" }, "columnMappings": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderImportColumnMapping" } }, "timeZoneName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResponderImportTemplateContent": { "enum": [ "OnlyBackgroundData", "IncludeAnswers" ], "type": "string" }, "ResponderImportValidationColumnMapping": { "required": [ "fileColumnId" ], "type": "object", "properties": { "metadataType": { "$ref": "#/components/schemas/ResponderDataMetadataType" }, "fileColumnId": { "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResponderIntegrityGuardStatus": { "enum": [ "Unchecked", "Approved", "Blocked", "Undefined" ], "type": "string" }, "ResponderLastSessionTerms": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/MultiTerms" }, "browserName": { "$ref": "#/components/schemas/MultiTerms" }, "osName": { "$ref": "#/components/schemas/MultiTerms" } }, "additionalProperties": false }, "ResponderOptOutStatus": { "enum": [ "NotOptedOut", "ByResponder", "ByAdministrator" ], "type": "string" }, "ResponderPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Responder" }, "nullable": true } }, "additionalProperties": false }, "ResponderPreferences": { "required": [ "optOut" ], "type": "object", "properties": { "optOut": { "type": "boolean" } }, "additionalProperties": false }, "ResponderPropertyAggregationBucket": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/ResponderAggregationProperty" }, "size": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ResponderPropertyStatisticsBucket": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/ResponderStatisticProperty" } }, "additionalProperties": false }, "ResponderQuery": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "filters": { "$ref": "#/components/schemas/ResponderQueryFilter" } }, "additionalProperties": false }, "ResponderQueryFilter": { "type": "object", "properties": { "range": { "$ref": "#/components/schemas/ResponderRangeFilter" }, "term": { "$ref": "#/components/schemas/ResponderTermsFilter" } }, "additionalProperties": false }, "ResponderQuerySortOrder": { "type": "object", "properties": { "dataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadataSortOrder" }, "nullable": true } }, "additionalProperties": false }, "ResponderRangeFilter": { "type": "object", "properties": { "mailCounters": { "$ref": "#/components/schemas/MailCountersRangeFilters" }, "dataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadataRangeFilter" }, "nullable": true } }, "additionalProperties": false }, "ResponderRegistry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "respondersAreAnonymous": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ResponderRegistryPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderRegistry" }, "nullable": true } }, "additionalProperties": false }, "ResponderSession": { "type": "object", "properties": { "guid": { "type": "string", "format": "uuid" }, "fieldPeriodId": { "type": "integer", "format": "int64", "nullable": true }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "browserName": { "type": "string", "nullable": true }, "browserVersion": { "type": "string", "nullable": true }, "osName": { "type": "string", "nullable": true }, "osVersion": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "state": { "$ref": "#/components/schemas/ResponderSessionState" } }, "additionalProperties": false }, "ResponderSessionAggregationProperty": { "enum": [ "Undefined", "State", "BrowserName", "OsName" ], "type": "string" }, "ResponderSessionPropertyType": { "enum": [ "Guid", "Undefined" ], "type": "string" }, "ResponderSessionState": { "enum": [ "Undefined", "NotStarted", "Started", "Finished" ], "type": "string" }, "ResponderSessionSummary": { "type": "object", "properties": { "guid": { "type": "string", "format": "uuid" }, "responderIdentifier": { "type": "string", "nullable": true }, "creationType": { "$ref": "#/components/schemas/ResponderCreationType" }, "alternativeResponderIdentifiers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "originResponderIdentifier": { "type": "string", "nullable": true }, "fieldPeriodIdentifier": { "type": "string", "nullable": true }, "enableDataExportForResponder": { "type": "boolean" }, "interimAnswerSaveMode": { "$ref": "#/components/schemas/InterimAnswerSaveMode" }, "cultureAlias": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResponderSessionUrl": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/components/schemas/ResponderSessionUrlType" }, "url": { "type": "string", "nullable": true }, "redirectDelay": { "$ref": "#/components/schemas/RedirectDelayType" }, "isAbsolute": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ResponderSessionUrlType": { "enum": [ "Undefined", "FieldPeriodRedirect", "UrlRedirect", "RestartFormRedirect", "RedirectToNewResponder" ], "type": "string" }, "ResponderSessionValueResolverConfiguration": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ResponderSessionPropertyType" } }, "additionalProperties": false }, "ResponderSortableQuery": { "type": "object", "properties": { "sorting": { "$ref": "#/components/schemas/ResponderQuerySortOrder" }, "query": { "type": "string", "nullable": true }, "filters": { "$ref": "#/components/schemas/ResponderQueryFilter" } }, "additionalProperties": false }, "ResponderStateCounter": { "type": "object", "properties": { "responderCount": { "type": "integer", "format": "int64" }, "notStartedCount": { "type": "integer", "format": "int64" }, "startedCount": { "type": "integer", "format": "int64" }, "finishedCount": { "type": "integer", "format": "int64" }, "notStartedShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "startedShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "finishedShare": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ResponderStatisticProperty": { "enum": [ "Undefined", "MailCountersSentForDelivery", "MailCountersBounced", "MailCountersDeliveryFailure" ], "type": "string" }, "ResponderStatisticsQuery": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ResponderQuery" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderPropertyStatisticsBucket" }, "nullable": true }, "dataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadataStatisticsBucket" }, "nullable": true } }, "additionalProperties": false }, "ResponderStatisticsResponse": { "type": "object", "properties": { "properties": { "type": "array", "items": { "$ref": "#/components/schemas/AggregationStatisticsResponseAggregationBucketSingleResponse" }, "nullable": true }, "dataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/AggregationStatisticsResponseAggregationBucketSingleResponse" }, "nullable": true } }, "additionalProperties": false }, "ResponderTermsFilter": { "type": "object", "properties": { "creationType": { "$ref": "#/components/schemas/MultiTerms" }, "optOutStatus": { "$ref": "#/components/schemas/MultiTerms" }, "responderGuid": { "$ref": "#/components/schemas/MultiTerms" }, "responderType": { "$ref": "#/components/schemas/MultiTerms" }, "belonging": { "$ref": "#/components/schemas/MultiTerms" }, "isActive": { "$ref": "#/components/schemas/Term" }, "isUsedForTesting": { "$ref": "#/components/schemas/Term" }, "lastSession": { "$ref": "#/components/schemas/ResponderLastSessionTerms" }, "dataMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/ResponderDataMetadataTermsFilter" }, "nullable": true } }, "additionalProperties": false }, "ResponderType": { "enum": [ "Undefined", "Regular", "Distributed" ], "type": "string" }, "ResponderUiType": { "enum": [ "Default", "AccessibleForm" ], "type": "string" }, "RewriteResponderDataAnswersResponse": { "type": "object", "properties": { "fieldPeriodId": { "type": "integer", "format": "int64" }, "insertedAnswerCount": { "type": "integer", "format": "int32" }, "reindexTaskId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RewriteResponderDataAnswersResponseNodeResponse": { "type": "object", "properties": { "node": { "type": "string", "nullable": true }, "object": { "$ref": "#/components/schemas/RewriteResponderDataAnswersResponse" } }, "additionalProperties": false }, "ScaleAnswer": { "type": "object", "properties": { "point": { "type": "number", "format": "double", "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "ScalePoint": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" }, "imageFile": { "$ref": "#/components/schemas/FileWithPublicUrl" } }, "additionalProperties": false }, "ScaleQuestion": { "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/ScalePoint" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ScaleQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ScaleQuestionUiSettings": { "type": "object", "properties": { "step": { "type": "integer", "format": "int32", "nullable": true }, "isNumbered": { "type": "boolean" }, "hideHeading": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ScheduledFieldPeriodMessageDistribution": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "distributionType": { "$ref": "#/components/schemas/ResponderDistributionType" }, "fieldPeriodMessageId": { "type": "integer", "format": "int64" }, "receiverMetadataId": { "type": "integer", "format": "int64" }, "senderFriendlyName": { "type": "string", "nullable": true }, "interval": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionInterval" }, "stopAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "lastExecutionTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "nextExecutionTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionStatus" } }, "additionalProperties": false }, "ScheduledFieldPeriodMessageDistributionBody": { "type": "object", "properties": { "senderFriendlyName": { "type": "string", "nullable": true }, "distributionType": { "$ref": "#/components/schemas/ResponderDistributionType" }, "receiverMetadataId": { "type": "integer", "format": "int64" }, "interval": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionInterval" }, "startAtUtc": { "type": "string", "format": "date-time" }, "stopAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "responderQuery": { "$ref": "#/components/schemas/ResponderQuery" }, "costCenterId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "ScheduledFieldPeriodMessageDistributionInterval": { "enum": [ "Hourly", "Daily", "Weekly", "Monthly", "Yearly" ], "type": "string" }, "ScheduledFieldPeriodMessageDistributionPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistribution" }, "nullable": true } }, "additionalProperties": false }, "ScheduledFieldPeriodMessageDistributionStatus": { "enum": [ "Queued", "Failed", "Processing", "Done" ], "type": "string" }, "ScheduledFieldPeriodMessageDistributionWithQuery": { "type": "object", "properties": { "responderQuery": { "$ref": "#/components/schemas/ResponderQuery" }, "id": { "type": "integer", "format": "int64" }, "distributionType": { "$ref": "#/components/schemas/ResponderDistributionType" }, "fieldPeriodMessageId": { "type": "integer", "format": "int64" }, "receiverMetadataId": { "type": "integer", "format": "int64" }, "senderFriendlyName": { "type": "string", "nullable": true }, "interval": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionInterval" }, "stopAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "lastExecutionTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "nextExecutionTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionStatus" } }, "additionalProperties": false }, "ScheduledFieldPeriodMessageStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "interval": { "$ref": "#/components/schemas/ScheduledFieldPeriodMessageDistributionInterval" }, "startAtUtc": { "type": "string", "format": "date-time" }, "stopAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SegmentFilterDataSource": { "enum": [ "Answer", "ResponderData", "Undefined" ], "type": "string" }, "SegmentedAnswers": { "type": "object", "properties": { "segmentGuid": { "type": "string", "format": "uuid" }, "answers": { "$ref": "#/components/schemas/AnswersContainer" }, "previewSegments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentedAnswers" }, "nullable": true } }, "additionalProperties": false }, "SharedReportExportReceipt": { "type": "object", "properties": { "batchId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "SmsPartCountForecastRequest": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "responderDataVariableDefaultLength": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SmsPartCountForecastResponse": { "type": "object", "properties": { "partCount": { "type": "integer", "format": "int32" }, "encodedLength": { "type": "integer", "format": "int32" }, "isGsm0338": { "type": "boolean" }, "containResponderMetaDataPlaceholders": { "type": "boolean" } }, "additionalProperties": false }, "SmsPrice": { "type": "object", "properties": { "countryName": { "type": "string", "nullable": true }, "countryIdentifier": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SmsPricePriceListWrapper": { "type": "object", "properties": { "validFrom": { "type": "string", "format": "date-time" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/SmsPrice" }, "nullable": true } }, "additionalProperties": false }, "SortOrder": { "enum": [ "Asc", "Desc", "Undefined" ], "type": "string" }, "StringArrayIOptionalProperty": { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StringArrayInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringArrayIOptionalProperty" }, "inheritedValue": { "type": "array", "items": { "type": "string" }, "nullable": true }, "calculatedValue": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "StringArrayOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringIChangedValue": { "type": "object", "properties": { "oldValue": { "type": "string", "nullable": true, "readOnly": true }, "newValue": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "StringIEnumerableNodeResponse": { "type": "object", "properties": { "node": { "type": "string", "nullable": true }, "object": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringListIOptionalProperty": { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "defined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StringListInheritedProperty": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringListIOptionalProperty" }, "inheritedValue": { "type": "array", "items": { "type": "string" }, "nullable": true }, "calculatedValue": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "StringListOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringOptionalProperty": { "type": "object", "properties": { "defined": { "type": "boolean" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringOptionalRequestProperty": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringStringKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubQuestion": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "referenceName": { "type": "string", "nullable": true }, "imageFile": { "$ref": "#/components/schemas/FileWithPublicUrl" }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "SupportAssistanceTargetEntity": { "required": [ "entityId" ], "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/EntityPermissionTargetType" }, "entityId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SupportCollectionType": { "enum": [ "General", "Overview", "Form", "Distribution", "Report", "UsersAndTeams", "ResponderApp", "ResponderRegistry" ], "type": "string" }, "SupportIssueType": { "enum": [ "Undefined", "HowTo", "Technical", "Bug", "FeatureRequest", "SalesQuestion" ], "type": "string" }, "SupportRequestClientParameter": { "required": [ "key" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SupportSeverityLevel": { "enum": [ "Urgent", "High", "Normal", "Minor" ], "type": "string" }, "SupportTeamAssistanceStatus": { "type": "object", "properties": { "hasAccess": { "type": "boolean" } }, "additionalProperties": false }, "SwedishPersonalIdentityNumberFormat": { "enum": [ "TenDigits", "TenDigitsWithSeparator", "TwelveDigits", "TwelveDigitsWithSeparator" ], "type": "string" }, "Team": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TeamHierarchyNode": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "entity": { "$ref": "#/components/schemas/Team" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/TeamIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "TeamIHierarchyNode": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/Team" }, "uri": { "type": "string", "format": "uri", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/TeamIHierarchyNode" }, "nullable": true } }, "additionalProperties": false }, "Term": { "type": "object", "properties": { "value": { "nullable": true } }, "additionalProperties": false }, "Text": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "content": { "$ref": "#/components/schemas/MarkupText" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "uiSettings": { "$ref": "#/components/schemas/TextUiSettings" }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TextMarkupType": { "enum": [ "None", "Markdown", "Html", "PlainText" ], "type": "string" }, "TextMatrixAlternativeAnswer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "value": { "nullable": true }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" } }, "additionalProperties": false }, "TextMatrixQuestion": { "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/SubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/Alternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/QuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TextMatrixQuestionAnswer": { "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/TextMatrixSubQuestionAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "TextMatrixSubQuestionAnswer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/TextMatrixAlternativeAnswer" }, "nullable": true } }, "additionalProperties": false }, "TextMultipleFieldsQuestion": { "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/TypedSubQuestion" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "masterCultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "existingCultureAliases": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TextMultipleFieldsQuestionAnswer": { "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/TextMultipleFieldsSubQuestionAnswer" }, "nullable": true }, "contentId": { "type": "integer", "format": "int64" }, "contentInstanceId": { "type": "integer", "format": "int64" }, "contentInstanceUri": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "targetReference": { "$ref": "#/components/schemas/IAnswerTargetReference" } }, "additionalProperties": false }, "TextMultipleFieldsSubQuestionAnswer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "value": { "nullable": true }, "valueType": { "$ref": "#/components/schemas/TypableAnswerValueType" } }, "additionalProperties": false }, "TextUiSettings": { "type": "object", "properties": { "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TinyForm": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "uiType": { "$ref": "#/components/schemas/ResponderUiType" }, "templateId": { "type": "integer", "format": "int64" }, "templateIdentifier": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TinyFormPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TinyForm" }, "nullable": true } }, "additionalProperties": false }, "TinyReportShare": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "identifier": { "type": "string", "nullable": true }, "reportId": { "type": "integer", "format": "int64" }, "reportSegmentId": { "type": "integer", "format": "int64", "nullable": true }, "isExportable": { "type": "boolean" }, "showSegments": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TinyReportSharePagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TinyReportShare" }, "nullable": true } }, "additionalProperties": false }, "TinyResponderApp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "identifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TinyResponderAppPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TinyResponderApp" }, "nullable": true } }, "additionalProperties": false }, "TinyUser": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UserStatus" }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "isActive": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TinyUserPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TinyUser" }, "nullable": true } }, "additionalProperties": false }, "TranslationSource": { "enum": [ "Static", "Custom" ], "type": "string" }, "TypableAnswerValueType": { "enum": [ "Undefined", "String", "Decimal", "Integer", "Date", "DateTime", "Boolean", "Email", "Telephone", "PersonalIdentityNumber" ], "type": "string" }, "TypedSubQuestion": { "type": "object", "properties": { "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "referenceName": { "type": "string", "nullable": true }, "imageFile": { "$ref": "#/components/schemas/FileWithPublicUrl" }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "UpdatableActivity": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdatableAlternative": { "required": [ "title" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "UpdatableAnswerValidator": { "type": "object", "properties": { "settings": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableAnswerValidatorSetting" }, "nullable": true } }, "additionalProperties": false }, "UpdatableAnswerValidatorSetting": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdatableArea": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaUiSettings" } }, "additionalProperties": false }, "UpdatableAreaRepeater": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaRepeaterUiSettings" }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "labels": { "$ref": "#/components/schemas/UpdatableAreaRepeaterLabels" } }, "additionalProperties": false }, "UpdatableAreaRepeaterLabels": { "type": "object", "properties": { "addAreaButtonLabel": { "type": "string", "nullable": true }, "submitAreaButtonLabel": { "type": "string", "nullable": true }, "segmentsMissingLabel": { "type": "string", "nullable": true }, "deleteAnswerSegmentConfirm": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdatableAreaSegmenter": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/AreaSegmenterUiSettings" }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableAreaSegmenterAlternative" }, "nullable": true } }, "additionalProperties": false }, "UpdatableAreaSegmenterAlternative": { "required": [ "title" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "title": { "minLength": 1, "type": "string" }, "additionalNumberValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "UpdatableCanvasQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/CanvasQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableCustomizableAlternative": { "required": [ "title" ], "type": "object", "properties": { "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "header": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int64", "nullable": true }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "UpdatableDataSetTypeAheadQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "dataSetProviderId": { "type": "integer", "format": "int64" }, "dataSetProviderSettings": { "type": "array", "items": { "$ref": "#/components/schemas/MutableDataSetProviderSetting" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/DataSetTypeAheadQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableEntityGroup": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdatableFieldPeriod": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringOptionalProperty" }, "activateAt": { "$ref": "#/components/schemas/DateTimeNullableOptionalProperty" }, "finishAt": { "$ref": "#/components/schemas/DateTimeNullableOptionalProperty" }, "maximumNbrOfFinishedResponders": { "$ref": "#/components/schemas/Int16NullableOptionalProperty" }, "allowPublicLink": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "enableDataExportForResponder": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "interimAnswerSaveMode": { "$ref": "#/components/schemas/InterimAnswerSaveModeOptionalProperty" }, "clearExistingAnswersForResponder": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "allowResponderResuming": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "preferredCultureResponderDataMetadataId": { "$ref": "#/components/schemas/Int64NullableOptionalProperty" }, "uiSettings": { "$ref": "#/components/schemas/FieldPeriodUiSettingsOptionalProperty" }, "requireResponderAppAuthentication": { "$ref": "#/components/schemas/BooleanOptionalProperty" }, "disableAuthForResponderLinks": { "$ref": "#/components/schemas/BooleanOptionalProperty" } }, "additionalProperties": false }, "UpdatableFieldPeriodMessage": { "required": [ "body", "cultureAlias", "title" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string" }, "cultureAlias": { "minLength": 1, "type": "string" }, "subject": { "type": "string", "nullable": true }, "body": { "$ref": "#/components/schemas/MarkupText" } }, "additionalProperties": false }, "UpdatableFileQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/FileQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableForm": { "required": [ "name", "templateId" ], "type": "object", "properties": { "templateId": { "type": "integer", "format": "int64" }, "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdatableFormTemplate": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "css": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "receiptTemplateFileName": { "type": "string", "format": "uuid", "nullable": true }, "exportTemplateFileName": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdatableInputQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableMapQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/MapQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableOptionMatrixQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableSubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableCustomizableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionMatrixQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableOptionQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableCustomizableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableRankingAlternative": { "required": [ "title" ], "type": "object", "properties": { "allowedInput": { "$ref": "#/components/schemas/AllowedAlternativeInput" }, "id": { "type": "integer", "format": "int64", "nullable": true }, "title": { "minLength": 1, "type": "string" }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "additionalNumberValue": { "type": "number", "format": "double", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentAlternativeDisplayType" }, "nullable": true } }, "additionalProperties": false }, "UpdatableRankingQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableRankingAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/RankingQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableResponder": { "type": "object", "properties": { "responderType": { "$ref": "#/components/schemas/ResponderType" }, "responderData": { "type": "array", "items": { "$ref": "#/components/schemas/CreatableResponderData" }, "nullable": true }, "isActive": { "type": "boolean" }, "isUsedForTesting": { "type": "boolean" }, "isOptedOut": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableResponderRegistry": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 2147483647, "minLength": 1, "type": "string" }, "respondersAreAnonymous": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableScalePoint": { "required": [ "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" }, "imageFileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdatableScaleQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableScalePoint" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ScaleQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableSubQuestion": { "required": [ "title" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "title": { "minLength": 1, "type": "string" }, "referenceName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "UpdatableTeam": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdatableText": { "required": [ "content", "cultureAlias" ], "type": "object", "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/TextUiSettings" }, "cultureAlias": { "minLength": 1, "type": "string" }, "content": { "$ref": "#/components/schemas/MarkupText" } }, "additionalProperties": false }, "UpdatableTextMatrixQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableSubQuestion" }, "nullable": true }, "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/QuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableTextMultipleFieldsQuestion": { "required": [ "cultureAlias", "title" ], "type": "object", "properties": { "subQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatableTypedSubQuestion" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/InputQuestionUiSettings" }, "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "isPersonalData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatableTranslation": { "required": [ "key" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdatableTypedSubQuestion": { "required": [ "title" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "answerValueType": { "$ref": "#/components/schemas/TypableAnswerValueType" }, "title": { "minLength": 1, "type": "string" }, "referenceName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "imageFileName": { "type": "string", "nullable": true }, "displayType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSubQuestionDisplayType" }, "nullable": true } }, "additionalProperties": false }, "UpdatableUser": { "required": [ "cultureAlias", "email" ], "type": "object", "properties": { "email": { "minLength": 1, "pattern": "^[-0-9a-zA-ZäöåÄÖÅ.+_]+@[-0-9a-zA-ZäöåÄÖÅ.+_]+\\.[a-zA-Z]{2,63}$", "type": "string" }, "username": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "firstname": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "lastname": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "cellphone": { "pattern": "^(\\+|00)([1-9]{1}[0-9]{1}?).(\\d{5,})$", "type": "string", "nullable": true }, "description": { "maxLength": 1024, "minLength": 0, "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "pattern": "^[a-z]{2,3}(-[A-Z]{2})*", "type": "string" }, "status": { "$ref": "#/components/schemas/UserStatus" }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureClaim" }, "nullable": true }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "propertyBag": { "$ref": "#/components/schemas/UserPropertyBag" } }, "additionalProperties": false }, "UpdatableVersion": { "required": [ "versionName" ], "type": "object", "properties": { "versionName": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdateColorPalette": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "hexColors": { "pattern": "^#[A-Fa-f0-9]{6}$", "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateCostCenter": { "required": [ "companyName", "name", "organizationNumber" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "overdraftLimit": { "type": "number", "format": "double", "nullable": true }, "companyName": { "minLength": 1, "type": "string" }, "organizationNumber": { "minLength": 1, "type": "string" }, "vatNumber": { "type": "string", "nullable": true }, "invoiceAddress": { "type": "string", "nullable": true }, "invoicePostalCode": { "type": "string", "nullable": true }, "invoiceCity": { "type": "string", "nullable": true }, "invoiceCountry": { "type": "string", "nullable": true }, "invoiceReferenceNumber": { "type": "string", "nullable": true }, "invoiceEmail": { "type": "string", "nullable": true }, "contactFullName": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "contactPhoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCurrentUser": { "required": [ "cultureAlias" ], "type": "object", "properties": { "password": { "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@#$%^&+=_\\-!¡?()\\[\\]{}\\\\|;:',.<>\\/*`~€¥£₹•√π÷׶∆£¢€¥^°=§±]).{6,}$", "type": "string", "nullable": true }, "firstname": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "lastname": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "cellphone": { "pattern": "^(\\+|00)([1-9]{1}[0-9]{1}?).(\\d{5,})$", "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "pattern": "^[a-z]{2,3}(-[A-Z]{2})*", "type": "string" }, "uiSettings": { "$ref": "#/components/schemas/UserUiSettings" } }, "additionalProperties": false }, "UpdateDataSeries": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "cultureAlias": { "minLength": 1, "type": "string" }, "filterGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataScope": { "$ref": "#/components/schemas/ReportDataSeriesDataScope" }, "basedOnDataSeriesId": { "type": "integer", "format": "int64", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ReportDataSeriesUiSettings" }, "onlyFinished": { "type": "boolean", "nullable": true }, "onlyFinishedAfter": { "type": "string", "format": "date-time", "nullable": true }, "onlyFinishedBefore": { "type": "string", "format": "date-time", "nullable": true }, "includeTestResponders": { "type": "boolean", "nullable": true }, "includeInactiveResponders": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateDataSource": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdateFieldPeriodResponderAuthProvider": { "type": "object", "properties": { "costCenterId": { "type": "integer", "format": "int64", "nullable": true }, "autoProvisioning": { "type": "boolean" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProviderMappingField" }, "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "autoProvisionMappings": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPeriodResponderAuthProviderAutoProvisionMappingField" }, "nullable": true } }, "additionalProperties": false }, "UpdateReport": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "documentExportTemplateFileName": { "type": "string", "format": "uuid", "nullable": true }, "onlyFinished": { "type": "boolean", "nullable": true }, "onlyFinishedAfter": { "type": "string", "format": "date-time", "nullable": true }, "onlyFinishedBefore": { "type": "string", "format": "date-time", "nullable": true }, "includeTestResponders": { "type": "boolean", "nullable": true }, "includeInactiveResponders": { "type": "boolean", "nullable": true }, "respondersAreAnonymous": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionalReportUiSettings" } }, "additionalProperties": false }, "UpdateReportItemAlternative": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "guid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ReportItemAlternativeType" }, "statisticMeasureWeight": { "type": "number", "format": "double", "nullable": true }, "percentageBaseGroup": { "type": "string", "format": "uuid", "nullable": true }, "mergedFromGuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UpdateReportItemAnswerList": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemAnswerListUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemDataTable": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateReportItemAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemDataTableUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemIndex": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemIndexUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemMatrixStatistics": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemMatrixStatisticsUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemNps": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateReportItemAlternative" }, "nullable": true }, "npsAlternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateReportItemAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemNpsUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemNumberStatistics": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemRankedDataTable": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "alternatives": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateReportItemAlternative" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemRankedDataTableUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemResponseRate": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateReportItemText": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "uiSettings": { "$ref": "#/components/schemas/OptionalReportItemUiSettings" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "cultureAlias": { "minLength": 1, "type": "string" }, "excludedDataSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "dataSeriesScope": { "$ref": "#/components/schemas/ReportItemDataSeriesScope" } }, "additionalProperties": false }, "UpdateResponderApp": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "entryFieldPeriodId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "UpdateResponderAppWidget": { "required": [ "cultureAlias", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "menuWidget": { "$ref": "#/components/schemas/MenuWidgetConfiguration" }, "formListWidget": { "$ref": "#/components/schemas/FormListWidgetConfiguration" }, "informationBarWidget": { "$ref": "#/components/schemas/InformationBarWidgetConfiguration" }, "cultureAlias": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdateResponderAuthProvider": { "required": [ "mappingDefinition", "name", "scheme" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "scheme": { "minLength": 1, "type": "string" }, "autoProvisioningCapability": { "type": "boolean" }, "authCreditCost": { "type": "number", "format": "double" }, "mappingDefinition": { "$ref": "#/components/schemas/ResponderAuthProviderMappingDefinition" }, "autoProvisionMappingDefinition": { "$ref": "#/components/schemas/ResponderAuthProviderAutoProvisionMappingDefinition" } }, "additionalProperties": false }, "UpdateResponderDataMetadata": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 2147483647, "minLength": 1, "type": "string" }, "isPersonalData": { "type": "boolean", "nullable": true }, "useAsAlternativeResponderIdentifier": { "type": "boolean", "nullable": true }, "autoRandomizeUniqueValue": { "type": "boolean", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/ResponderDataMetadataUiSettings" } }, "additionalProperties": false }, "Url": { "type": "object", "properties": { "relative": { "type": "string", "nullable": true }, "absolute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UrlRedirectEventConfiguration": { "type": "object", "properties": { "redirectUrl": { "type": "string", "nullable": true }, "redirectDelay": { "$ref": "#/components/schemas/RedirectDelayType" } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "cellphone": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UserStatus" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureClaim" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/IUserUiSettings" }, "isActive": { "type": "boolean", "readOnly": true }, "isServiceUser": { "type": "boolean" }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "propertyBag": { "$ref": "#/components/schemas/IUserPropertyBag" } }, "additionalProperties": false }, "UserExtended": { "type": "object", "properties": { "identityProviders": { "type": "array", "items": { "type": "string" }, "nullable": true }, "id": { "type": "integer", "format": "int64" }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "cellphone": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UserStatus" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureClaim" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/IUserUiSettings" }, "isActive": { "type": "boolean", "readOnly": true }, "isServiceUser": { "type": "boolean" }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "propertyBag": { "$ref": "#/components/schemas/IUserPropertyBag" } }, "additionalProperties": false }, "UserExtendedPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserExtended" }, "nullable": true } }, "additionalProperties": false }, "UserNotificationApplicationContext": { "type": "object", "properties": { "contextType": { "$ref": "#/components/schemas/UserNotificationApplicationContextType" }, "contextId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "UserNotificationApplicationContextType": { "enum": [ "Unspecified", "FormVersion", "FieldPeriod", "Report", "UserManagement", "ResponderRegistry", "ResponderApp", "Overview" ], "type": "string" }, "UserNotificationMessageLevel": { "enum": [ "Information", "Warning", "Undefined" ], "type": "string" }, "UserNotificationMessageType": { "enum": [ "SystemIncident", "DataInconsistency", "FieldPeriodMessageSent", "Undefined" ], "type": "string" }, "UserNotificationTarget": { "enum": [ "All", "User", "Undefined" ], "type": "string" }, "UserOtpVerification": { "type": "object", "properties": { "otpCode": { "type": "string", "nullable": true }, "deviceToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserPasswordResetStatus": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "ok": { "type": "boolean" } }, "additionalProperties": false }, "UserPropertyBag": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/UserPropertyBagEntry" }, "nullable": true } }, "additionalProperties": false }, "UserPropertyBagEntry": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "nullable": true }, "type": { "$ref": "#/components/schemas/UserPropertyBagType" } }, "additionalProperties": false }, "UserPropertyBagType": { "enum": [ "Undefined", "String", "Number", "DateTime", "Email", "Telephone", "Culture" ], "type": "string" }, "UserRequest": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int64" }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "cellphone": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UserStatus" }, "cultureAlias": { "type": "string", "nullable": true, "readOnly": true }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureClaim" }, "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/IUserUiSettings" }, "isActive": { "type": "boolean", "readOnly": true }, "isServiceUser": { "type": "boolean" }, "responderAppId": { "type": "integer", "format": "int64", "nullable": true }, "propertyBag": { "$ref": "#/components/schemas/IUserPropertyBag" } }, "additionalProperties": false }, "UserRequestPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserRequest" }, "nullable": true } }, "additionalProperties": false }, "UserRequestResponse": { "required": [ "isApproved" ], "type": "object", "properties": { "isApproved": { "type": "boolean" }, "teamId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "UserRequestSource": { "enum": [ "Undefined", "RequestBody", "CurrentPrincipal" ], "type": "string" }, "UserStatus": { "enum": [ "Active", "Pending", "Rejected", "Inactive" ], "type": "string" }, "UserUiSettings": { "type": "object", "properties": { "floatingWorkbenchHeader": { "type": "boolean", "nullable": true }, "floatingWorkbenchFlowBar": { "type": "boolean", "nullable": true }, "editorFormDefaultValues": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "accessedObjects": { "type": "array", "items": { "$ref": "#/components/schemas/AccessedObject" }, "nullable": true }, "hideSupportHints": { "type": "boolean", "nullable": true }, "cssClasses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ValidationType": { "enum": [ "Undefined", "Required", "MinAlternative", "MaxAlternative", "FileFormat", "MinValue", "MaxValue" ], "type": "string" }, "ValidatorEntityType": { "enum": [ "Undefined", "Question" ], "type": "string" }, "Version": { "type": "object", "properties": { "versionId": { "type": "integer", "format": "int64" }, "versionName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "VersionPagedList": { "type": "object", "properties": { "totalNbrOfItems": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Version" }, "nullable": true } }, "additionalProperties": false }, "VersionableEntityType": { "enum": [ "Undefined", "Form" ], "type": "string" }, "WidgetType": { "enum": [ "Menu", "FormList", "InformationBar", "Undefined" ], "type": "string" } } } }