API v2.1 · Reference
API overview
Operate teams, members, study authoring, translations, publication, participation, results, retention and deletion through the API. Initial sign-in, key issuance and sensitive authentication settings use the web. Existing credentials do not gain new scopes automatically; issue a key or re-consent with the required permissions.
https://realvoicesurvey.com/api/v2
Authentication and API keys
Creating or rotating an API key requires additional authentication. Both are blocked for 24 hours after account recovery.
Using a recovery code revokes all existing API keys and OAuth connections. Reset your security methods and reconnect the integrations you need.
Send Authorization: Bearer <token> on every protected request. API keys start with rv2_. Web sign-in tokens cannot replace API keys.
Choose a name, permissions, project and expiry (7, 30 or 90 days). You can have 10 active keys. The secret is shown only when issued. Store it in a server environment variable or secret manager.
Revocation stops new requests immediately. Signing out does not revoke API keys. OAuth connections have separate consent and revocation. OAuth cannot create or rotate user API keys.
Permissions and project scope
Every request intersects current account access, credential scopes, project restrictions and data policy. A key never grants permissions the user does not have.
account:read- Read my account
projects:read- List projects
workspace:read- List workspaces and studies
credentials:manage- List and revoke credentials
studies:read- Read study drafts and versions
studies:write- Read, create and edit study drafts
credentials:rotate- Replace this API key
publish:write- Publish studies and change collection status and sharing instructions
participation:write- Participate and manage my answers
responses:read- Read collection results and responses
responses:export- Export responses
responses:identifiable- Read free text, transcripts and contacts
responses:review- Request interview record review
account:write- Change my profile and preferences
workspace:write- Create and manage teams and projects
members:read- Read members and data policies
members:write- Manage members, ownership and data policies
invitations:write- Read and manage in-app invitations
studies:delete- Archive, restore and delete studies
responses:delete- Delete responses and shorten retention
ai:write- Run paid AI study authoring
support:write- Contact · Funding requests
admin:operate- Perform authorized service administration
Service workflows
Create a team/project, then manage settings and members with current versions. Author a study directly or from a saved consultation. Validate, review translations and preview publication before committing. Keep attemptId when resuming participation. Inspect results before archive, restore or deletion.
service_settings_write → service_members_write / service_invitations_write study_draft_save / service_study_start_write → study_validate service_translations_preview_read → service_translations_refresh_write service_translations_write (review) → publication_preview → publication_commit participation_start → participation_save / participation_submit results_overview / responses_export → service_study_lifecycle_write
Team operations need an account-wide credential. Project-bound credentials operate only on that project. Permanent deletion requires the current name, affected count, review hash and explicit acknowledgment. Existing cleanup jobs remove files after acceptance; logical deletion and physical cleanup may complete at different times.
Translations and language results
Save source, default and offered languages in study settings. Preview sourceHash and changed/reused counts, then refresh with the same hash and confirmCost=true. Polling state is free. Review every ready language before publication; source changes require another review.
GET /service/translations/preview?study=STUDY_UUID
POST /service/translations/refresh
{ "study": "STUDY_UUID", "sourceHash": "PREVIEW_HASH", "confirmCost": true }
GET /service/translations?study=STUDY_UUID
POST /service/translations
{ "study": "STUDY_UUID", "action": "review", "locale": "ja", "sourceHash": "PREVIEW_HASH" }Use locale for participation preview/start. A resumed response keeps its original language. Results, responses, text, evidence and exports accept language: omitted/empty means all; unknown selects responses without a recorded language. Filtering happens before aggregates and pagination.
Do not automatically repeat unknown or WORKER_UNCONFIRMED work while billing is unresolved. retryable=false requires reviewing existing reservations first. Resolve languages listed in publication preview translationReadiness.blockers before committing.
AI tools and CLI
REST and MCP share operations, scopes and inputs. Use https://realvoicesurvey.com/mcp; tools/list shows permitted operations. Read outputSchema and structuredContent.data. httpStatus=202 requires polling the operation until completion.
Paid service actions such as translation, authoring and new transcription require confirmCost=true. Wait for the actual retryAfter. Preserve versions, requestId and attemptId; do not create a fresh paid request after a lost response.
rv operations
rv operations service_notifications_write
rv call service_notifications_read --file arguments.json
rv call service_notifications_write --file arguments.json --confirm
# arguments.json: { "body": { "version": 1, "field": "mentions", "enabled": true } }
# authentication: rv login (once per device)
# binary/exports: add --out result.zipInspect operations and inputs with rv operations. Pass a MCP-style {path,query,body} file to rv call. Mutations require --confirm. Follow the CLI setup guide to install and connect.
Lists and pagination
Project, workspace and study lists use limit (1–100, default 50) and cursor. Pass the returned nextCursor on the next request; null means the end. Response, free-text and evidence lists use zero-based page indexes; page sizes are 50, 20 and 5 respectively.
Retrieve projects
curl 'https://realvoicesurvey.com/api/v2/projects?limit=50' \ -H "Authorization: Bearer $REALVOICE_API_KEY"
Requires projects:read. The response includes items and nextCursor.
All endpoints
Expand an operation to inspect parameters, request and response schemas. This reference is generated from the same contract as the published OpenAPI specification.
GET/me
me_read
Required scopes: account:read
Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"userId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"displayName": {
"type": "string"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"credential": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"account:read",
"projects:read",
"workspace:read",
"credentials:manage",
"studies:read",
"studies:write",
"credentials:rotate",
"publish:write",
"participation:write",
"responses:read",
"responses:export",
"responses:identifiable",
"responses:review",
"account:write",
"workspace:write",
"members:read",
"members:write",
"invitations:write",
"studies:delete",
"responses:delete",
"ai:write",
"support:write",
"admin:operate"
]
}
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"revokedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"scopes",
"projectId",
"createdAt",
"expiresAt",
"revokedAt",
"lastUsedAt"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"account:read",
"projects:read",
"workspace:read",
"credentials:manage",
"studies:read",
"studies:write",
"credentials:rotate",
"publish:write",
"participation:write",
"responses:read",
"responses:export",
"responses:identifiable",
"responses:review",
"account:write",
"workspace:write",
"members:read",
"members:write",
"invitations:write",
"studies:delete",
"responses:delete",
"ai:write",
"support:write",
"admin:operate"
]
}
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"revokedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"const": "oauth"
},
"clientId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"resource": {
"type": "string",
"enum": [
"https://realvoicesurvey.com/api/v2",
"https://realvoicesurvey.com/mcp",
"https://realvoice-survey.vercel.app/api/v2",
"https://realvoice-survey.vercel.app/mcp"
]
}
},
"required": [
"id",
"name",
"scopes",
"projectId",
"createdAt",
"expiresAt",
"revokedAt",
"lastUsedAt",
"kind",
"clientId",
"resource"
],
"additionalProperties": false
}
]
}
},
"required": [
"userId",
"displayName",
"locale",
"credential"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/projects
projects_list
Required scopes: projects:read
Parameters
[
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}
}
]Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"visibility": {
"type": "string",
"enum": [
"team",
"invite"
]
},
"archivedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"role": {
"type": "string",
"enum": [
"admin",
"editor",
"viewer"
]
}
},
"required": [
"id",
"name",
"teamId",
"version",
"visibility",
"archivedAt",
"role"
],
"additionalProperties": false
}
},
"nextCursor": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"nextCursor"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/workspace
workspace_list
Required scopes: workspace:read
Parameters
[
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}
}
]Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"role": {
"type": "string",
"enum": [
"owner",
"admin",
"member",
"editor",
"viewer",
"guest"
]
}
},
"required": [
"id",
"name",
"version",
"role"
],
"additionalProperties": false
}
},
"nextCursor": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"nextCursor"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies
studies_list
Required scopes: workspace:read
Parameters
[
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}
},
{
"name": "project",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "q",
"in": "query",
"schema": {
"type": "string",
"maxLength": 160
}
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"all",
"draft",
"scheduled",
"collecting",
"paused",
"closed"
],
"default": "all"
}
},
{
"name": "archive",
"in": "query",
"schema": {
"type": "string",
"enum": [
"all",
"active",
"archived"
],
"default": "active"
}
}
]Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"surveyCompleted": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"interviewCompleted": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"closedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"archived": {
"type": "boolean"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"projectId",
"title",
"kind",
"status",
"version",
"surveyGoal",
"interviewGoal",
"surveyCompleted",
"interviewCompleted",
"startsAt",
"endsAt",
"closedAt",
"archived",
"updatedAt"
],
"additionalProperties": false
}
},
"nextCursor": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"nextCursor"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/keys
keys_list
Required scopes: credentials:manage
Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"account:read",
"projects:read",
"workspace:read",
"credentials:manage",
"studies:read",
"studies:write",
"credentials:rotate",
"publish:write",
"participation:write",
"responses:read",
"responses:export",
"responses:identifiable",
"responses:review",
"account:write",
"workspace:write",
"members:read",
"members:write",
"invitations:write",
"studies:delete",
"responses:delete",
"ai:write",
"support:write",
"admin:operate"
]
}
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"revokedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"scopes",
"projectId",
"createdAt",
"expiresAt",
"revokedAt",
"lastUsedAt"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/oauth/grants
oauth_grant_read
Required scopes: credentials:manage
Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"account:read",
"projects:read",
"workspace:read",
"credentials:manage",
"studies:read",
"studies:write",
"credentials:rotate",
"publish:write",
"participation:write",
"responses:read",
"responses:export",
"responses:identifiable",
"responses:review",
"account:write",
"workspace:write",
"members:read",
"members:write",
"invitations:write",
"studies:delete",
"responses:delete",
"ai:write",
"support:write",
"admin:operate"
]
}
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"revokedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"const": "oauth"
},
"clientId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"resource": {
"type": "string",
"enum": [
"https://realvoicesurvey.com/api/v2",
"https://realvoicesurvey.com/mcp",
"https://realvoice-survey.vercel.app/api/v2",
"https://realvoice-survey.vercel.app/mcp"
]
}
},
"required": [
"id",
"name",
"scopes",
"projectId",
"createdAt",
"expiresAt",
"revokedAt",
"lastUsedAt",
"kind",
"clientId",
"resource"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}DELETE/oauth/grants/{id}
oauth_grant_revoke
Required scopes: credentials:manage
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"revoked": {
"type": "boolean",
"const": true
}
},
"required": [
"id",
"revoked"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}DELETE/keys/{id}
keys_revoke
Required scopes: credentials:manage
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Responses
{
"200": {
"description": "Success; project authority is checked on every request.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"revoked": {
"type": "boolean",
"const": true
}
},
"required": [
"id",
"revoked"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}
study_read
Required scopes: studies:read / studies:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "version",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
}
]Responses
{
"200": {
"description": "Saved draft or immutable version. Saving never publishes.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"currentVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"distribution": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
},
"notice": {
"type": "string",
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"additionalProperties": false
},
"reason": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"role": {
"type": "string",
"enum": [
"admin",
"editor",
"viewer"
]
},
"archived": {
"type": "boolean"
},
"incomingQuestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
}
},
"required": [
"studyId",
"projectId",
"title",
"kind",
"version",
"currentVersion",
"design",
"distribution",
"reason",
"createdAt",
"role",
"archived",
"incomingQuestions"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}PUT/studies/{id}
study_draft_save
Create with version=0 and a caller-generated study UUID. Edit with the current version. Reuse the same requestId and exact input after a lost response; changed input conflicts.
Required scopes: studies:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"distribution": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
},
"notice": {
"type": "string",
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"additionalProperties": false
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"required": [
"projectId",
"requestId",
"version",
"title",
"kind",
"design",
"reason"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Saved draft or immutable version. Saving never publishes.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"currentVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"distribution": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
},
"notice": {
"type": "string",
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"additionalProperties": false
},
"reason": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"role": {
"type": "string",
"enum": [
"admin",
"editor",
"viewer"
]
},
"archived": {
"type": "boolean"
},
"incomingQuestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
}
},
"required": [
"studyId",
"projectId",
"title",
"kind",
"version",
"currentVersion",
"design",
"distribution",
"reason",
"createdAt",
"role",
"archived",
"incomingQuestions"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/validate
study_validate
Required scopes: studies:read / studies:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Non-AI design checks against the saved draft.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"valid": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string",
"enum": [
"error",
"recommendation"
]
}
},
"required": [
"target",
"message",
"severity"
],
"additionalProperties": false
}
}
},
"required": [
"studyId",
"version",
"valid",
"issues"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/publication
publication_commit
Required scopes: publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
],
"additionalProperties": false
},
"test": {
"type": "boolean"
},
"reopen": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"survey",
"interview"
]
}
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"version",
"settings",
"test",
"reopen",
"requestId",
"reviewHash",
"confirm"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current state; retries do not restore earlier state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"share": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"reward": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"title",
"reward",
"revision"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"isTest": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"version",
"isTest",
"createdAt",
"settings",
"url"
],
"additionalProperties": false
}
},
"operation": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"publish",
"status",
"share"
]
},
"publicationId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"requestId",
"action",
"publicationId"
],
"additionalProperties": false
}
},
"required": [
"studyId",
"version",
"status",
"publicUrl",
"share",
"publications",
"operation"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/publication
publication_read
Required scopes: studies:read / studies:write / publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Responses
{
"200": {
"description": "Immutable publication metadata, current collection state and share links.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"share": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"reward": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"title",
"reward",
"revision"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"isTest": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"version",
"isTest",
"createdAt",
"settings",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"studyId",
"version",
"status",
"publicUrl",
"share",
"publications"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/publication/preview
publication_preview
Required scopes: publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
],
"additionalProperties": false
},
"test": {
"type": "boolean"
},
"reopen": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"survey",
"interview"
]
}
}
},
"required": [
"version",
"settings",
"test",
"reopen"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current state; retries do not restore earlier state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"translationReadiness": {
"anyOf": [
{
"type": "object",
"properties": {
"sourceHash": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"status": {
"type": "string"
}
},
"required": [
"locale",
"status"
]
}
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"status": {
"type": "string"
},
"code": {
"type": "string",
"const": "TRANSLATION_NOT_READY"
}
},
"required": [
"locale",
"status",
"code"
]
}
}
},
"required": [
"sourceHash",
"languages",
"blockers"
]
},
{
"type": "null"
}
]
},
"current": {
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"share": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"reward": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"title",
"reward",
"revision"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"isTest": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"version",
"isTest",
"createdAt",
"settings",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"studyId",
"version",
"status",
"publicUrl",
"share",
"publications"
],
"additionalProperties": false
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"inFlight": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
],
"additionalProperties": false
},
"test": {
"type": "boolean"
},
"reopen": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"survey",
"interview"
]
}
}
},
"required": [
"version",
"settings",
"test",
"reopen"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"paused",
"collecting",
"closed"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"reward": {
"type": "string",
"maxLength": 30
}
},
"required": [
"title",
"reward"
],
"additionalProperties": false
}
]
}
},
"required": [
"current",
"reviewHash",
"inFlight",
"valid",
"errors",
"warnings",
"design",
"input"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/collection-status
collection_status_commit
Required scopes: publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"paused",
"collecting",
"closed"
]
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"status",
"requestId",
"reviewHash",
"confirm"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current state; retries do not restore earlier state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"share": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"reward": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"title",
"reward",
"revision"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"isTest": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"version",
"isTest",
"createdAt",
"settings",
"url"
],
"additionalProperties": false
}
},
"operation": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"publish",
"status",
"share"
]
},
"publicationId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"requestId",
"action",
"publicationId"
],
"additionalProperties": false
}
},
"required": [
"studyId",
"version",
"status",
"publicUrl",
"share",
"publications",
"operation"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/collection-status/preview
collection_status_preview
Required scopes: publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"paused",
"collecting",
"closed"
]
}
},
"required": [
"status"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current state; retries do not restore earlier state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"translationReadiness": {
"anyOf": [
{
"type": "object",
"properties": {
"sourceHash": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"status": {
"type": "string"
}
},
"required": [
"locale",
"status"
]
}
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"status": {
"type": "string"
},
"code": {
"type": "string",
"const": "TRANSLATION_NOT_READY"
}
},
"required": [
"locale",
"status",
"code"
]
}
}
},
"required": [
"sourceHash",
"languages",
"blockers"
]
},
{
"type": "null"
}
]
},
"current": {
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"share": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"reward": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"title",
"reward",
"revision"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"isTest": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"version",
"isTest",
"createdAt",
"settings",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"studyId",
"version",
"status",
"publicUrl",
"share",
"publications"
],
"additionalProperties": false
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"inFlight": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
],
"additionalProperties": false
},
"test": {
"type": "boolean"
},
"reopen": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"survey",
"interview"
]
}
}
},
"required": [
"version",
"settings",
"test",
"reopen"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"paused",
"collecting",
"closed"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"reward": {
"type": "string",
"maxLength": 30
}
},
"required": [
"title",
"reward"
],
"additionalProperties": false
}
]
}
},
"required": [
"current",
"reviewHash",
"inFlight",
"valid",
"errors",
"warnings",
"design",
"input"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/share
share_commit
Required scopes: publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"reward": {
"type": "string",
"maxLength": 30
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"title",
"reward",
"requestId",
"reviewHash",
"confirm"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current state; retries do not restore earlier state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"share": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"reward": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"title",
"reward",
"revision"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"isTest": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"version",
"isTest",
"createdAt",
"settings",
"url"
],
"additionalProperties": false
}
},
"operation": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"publish",
"status",
"share"
]
},
"publicationId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"requestId",
"action",
"publicationId"
],
"additionalProperties": false
}
},
"required": [
"studyId",
"version",
"status",
"publicUrl",
"share",
"publications",
"operation"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/share/preview
share_preview
Required scopes: publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"reward": {
"type": "string",
"maxLength": 30
}
},
"required": [
"title",
"reward"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current state; retries do not restore earlier state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"translationReadiness": {
"anyOf": [
{
"type": "object",
"properties": {
"sourceHash": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"status": {
"type": "string"
}
},
"required": [
"locale",
"status"
]
}
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"status": {
"type": "string"
},
"code": {
"type": "string",
"const": "TRANSLATION_NOT_READY"
}
},
"required": [
"locale",
"status",
"code"
]
}
}
},
"required": [
"sourceHash",
"languages",
"blockers"
]
},
{
"type": "null"
}
]
},
"current": {
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"share": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"reward": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"title",
"reward",
"revision"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"isTest": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"version",
"isTest",
"createdAt",
"settings",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"studyId",
"version",
"status",
"publicUrl",
"share",
"publications"
],
"additionalProperties": false
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"inFlight": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string",
"minLength": 10,
"maxLength": 6000
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
],
"additionalProperties": false
},
"test": {
"type": "boolean"
},
"reopen": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"survey",
"interview"
]
}
}
},
"required": [
"version",
"settings",
"test",
"reopen"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"paused",
"collecting",
"closed"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"reward": {
"type": "string",
"maxLength": 30
}
},
"required": [
"title",
"reward"
],
"additionalProperties": false
}
]
}
},
"required": [
"current",
"reviewHash",
"inFlight",
"valid",
"errors",
"warnings",
"design",
"input"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/share/qr
share_qr_export
Download a PNG using the published participation URL and current saved invitation title. QR is 1200×1200; invitation card is 1200×1480. Unpublished studies return 409 PUBLICATION_REQUIRED. No key is embedded in the image.
Required scopes: studies:read / studies:write / publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locale",
"in": "query",
"schema": {
"type": "string",
"enum": [
"ko",
"en"
],
"default": "ko"
}
}
]Responses
{
"200": {
"description": "Private authorized PNG download.",
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/share/card
share_card_export
Download a PNG using the published participation URL and current saved invitation title. QR is 1200×1200; invitation card is 1200×1480. Unpublished studies return 409 PUBLICATION_REQUIRED. No key is embedded in the image.
Required scopes: studies:read / studies:write / publish:write
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locale",
"in": "query",
"schema": {
"type": "string",
"enum": [
"ko",
"en"
],
"default": "ko"
}
}
]Responses
{
"200": {
"description": "Private authorized PNG download.",
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/participations/{link}
participation_read
Returns consent introduction before starting; otherwise the current response. Keep a stable attemptId for guest continuity across credentials belonging to the same account. Login-required responses use the existing account response.
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attemptId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "test",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "locale",
"in": "query",
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
]Responses
{
"200": {
"description": "The same public participant view as the web. No internal identity, token, cost or research evidence fields.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"intro": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
"voiceInput": {
"type": "boolean"
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"targetMinutes": {
"type": "number"
},
"transferQuestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
],
"additionalProperties": false
}
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"publicationId",
"welcome",
"assets",
"title",
"kind",
"isTest",
"notice",
"retentionUntil",
"targetMinutes",
"transferQuestions"
],
"additionalProperties": false
}
},
"required": [
"intro"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/participations/{link}/start
participation_start
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"consent": {
"type": "boolean",
"const": true
},
"transferConsent": {
"type": "boolean"
}
},
"required": [
"attemptId",
"test",
"requestId",
"publicationId",
"consent",
"transferConsent"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "The same public participant view as the web. No internal identity, token, cost or research evidence fields.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"intro": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
"voiceInput": {
"type": "boolean"
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"targetMinutes": {
"type": "number"
},
"transferQuestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
],
"additionalProperties": false
}
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"publicationId",
"welcome",
"assets",
"title",
"kind",
"isTest",
"notice",
"retentionUntil",
"targetMinutes",
"transferQuestions"
],
"additionalProperties": false
}
},
"required": [
"intro"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/participations/{link}/save
participation_save
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"questionId": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
}
},
"required": [
"attemptId",
"test",
"requestId",
"participationId",
"version",
"answers",
"questionId"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "The same public participant view as the web. No internal identity, token, cost or research evidence fields.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"intro": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
"voiceInput": {
"type": "boolean"
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"targetMinutes": {
"type": "number"
},
"transferQuestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
],
"additionalProperties": false
}
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"publicationId",
"welcome",
"assets",
"title",
"kind",
"isTest",
"notice",
"retentionUntil",
"targetMinutes",
"transferQuestions"
],
"additionalProperties": false
}
},
"required": [
"intro"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/participations/{link}/submit
participation_submit
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"questionId": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
}
},
"required": [
"attemptId",
"test",
"requestId",
"participationId",
"version",
"answers",
"questionId"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "The same public participant view as the web. No internal identity, token, cost or research evidence fields.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"intro": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
"voiceInput": {
"type": "boolean"
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"targetMinutes": {
"type": "number"
},
"transferQuestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
],
"additionalProperties": false
}
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"publicationId",
"welcome",
"assets",
"title",
"kind",
"isTest",
"notice",
"retentionUntil",
"targetMinutes",
"transferQuestions"
],
"additionalProperties": false
}
},
"required": [
"intro"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/participations/{link}/repeat
participation_repeat
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"attemptId",
"test",
"requestId",
"participationId",
"confirm"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "New attempt prepared. Read the introduction and explicitly consent again.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"restart": {
"type": "boolean",
"const": true
}
},
"required": [
"restart"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/participations/{link}/interview
interview_execute
start, answer, skip, pause, resume, stop or retry an admitted interview. Supply the current participationId/version. Keep requestId and exact input after a lost response. A new retry is permitted only after durable recovery and confirmed costs. Accepted work may finish after key revocation; new requests and polls recheck authority.
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"start",
"answer",
"skip",
"stop",
"pause",
"resume",
"retry"
]
},
"text": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"attemptId",
"test",
"participationId",
"version",
"requestId",
"action"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Durable operation and current committed participant state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"operation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"start",
"answer",
"skip",
"stop",
"pause",
"resume",
"retry"
]
},
"status": {
"type": "string",
"enum": [
"running",
"ready",
"failed",
"unknown",
"cancelled"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"errorCode": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"action",
"status",
"createdAt",
"finishedAt",
"errorCode"
],
"additionalProperties": false
},
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"required": [
"operation",
"state"
],
"additionalProperties": false
}
}
}
},
"202": {
"description": "Answer and job saved. Poll this operation; disconnect does not stop it or settle cost.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"operation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"start",
"answer",
"skip",
"stop",
"pause",
"resume",
"retry"
]
},
"status": {
"type": "string",
"enum": [
"running",
"ready",
"failed",
"unknown",
"cancelled"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"errorCode": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"action",
"status",
"createdAt",
"finishedAt",
"errorCode"
],
"additionalProperties": false
},
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"required": [
"operation",
"state"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/participations/{link}/interview/{request}
interview_operation_read
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "request",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attemptId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "test",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "locale",
"in": "query",
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
{
"name": "participationId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Responses
{
"200": {
"description": "Durable operation and current committed participant state.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"operation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"start",
"answer",
"skip",
"stop",
"pause",
"resume",
"retry"
]
},
"status": {
"type": "string",
"enum": [
"running",
"ready",
"failed",
"unknown",
"cancelled"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"errorCode": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"action",
"status",
"createdAt",
"finishedAt",
"errorCode"
],
"additionalProperties": false
},
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"required": [
"operation",
"state"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/participations/{link}/assets/{asset}
participation_asset_read
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "asset",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attemptId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "test",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "locale",
"in": "query",
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
]Responses
{
"200": {
"description": "Authorized welcome, question or ending media. The signed URL expires after 60 seconds.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"downloadUrl": {
"type": "string",
"format": "uri"
},
"downloadExpiresIn": {
"type": "number",
"const": 60
}
},
"required": [
"downloadUrl",
"downloadExpiresIn"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/keys/{id}/rotate
credential_rotate
Replace only the calling API key with identical scopes, project and expiry. A 403 API_STEP_UP_REQUIRED response supplies nextAction.url for native browser approval. Approve with MFA, then retry the same requestId within five minutes. Successful replacements can be retrieved with the same requestId within ten minutes. Store and verify the replacement, then explicitly revoke the old key.
Required scopes: credentials:manage + credentials:rotate
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"requestId",
"confirm"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Replacement secret; old key remains active until explicit revocation.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"account:read",
"projects:read",
"workspace:read",
"credentials:manage",
"studies:read",
"studies:write",
"credentials:rotate",
"publish:write",
"participation:write",
"responses:read",
"responses:export",
"responses:identifiable",
"responses:review",
"account:write",
"workspace:write",
"members:read",
"members:write",
"invitations:write",
"studies:delete",
"responses:delete",
"ai:write",
"support:write",
"admin:operate"
]
}
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"revokedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"key": {
"type": "string"
},
"replacesId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"oldKeyActive": {
"type": "boolean",
"const": true
}
},
"required": [
"id",
"name",
"scopes",
"projectId",
"createdAt",
"expiresAt",
"revokedAt",
"lastUsedAt",
"key",
"replacesId",
"oldKeyActive"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/results
results_overview
Current project data policy intersects credential scopes on every call. Free text, transcripts and contacts require responses:identifiable. Zero-based pages: response list 50, text 20, evidence 5. Totals/arrival include flagged responses; includeFlagged filters rows/distributions/exports. Export excludes test/expired/deleted responses and fails with EXPORT_TOO_LARGE above 5,000 responses or 50,000 turns; no truncation.
Required scopes: responses:read
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeFlagged",
"in": "query",
"required": false,
"schema": {
"default": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "string",
"enum": [
"",
"unknown"
]
}
]
}
},
{
"name": "timeZone",
"in": "query",
"required": false,
"schema": {
"default": "Asia/Seoul",
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
]Responses
{
"200": {
"description": "Authorized collection data; internal identity, credential and job lease fields are omitted.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"auto_close": {
"type": "boolean"
},
"survey_goal": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"interview_goal": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"survey_completed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"interview_completed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"starts_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ends_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"survey_closed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"interview_closed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"archived_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"project_id",
"title",
"kind",
"status",
"version",
"auto_close",
"survey_goal",
"interview_goal",
"survey_completed",
"interview_completed",
"starts_at",
"ends_at",
"survey_closed_at",
"interview_closed_at",
"archived_at"
]
},
"role": {
"type": "string",
"enum": [
"admin",
"editor",
"viewer"
]
},
"policy": {
"type": "object",
"properties": {
"aggregate": {
"type": "boolean"
},
"raw": {
"type": "boolean"
},
"identifiable": {
"type": "boolean"
},
"export": {
"type": "boolean"
}
},
"required": [
"aggregate",
"raw",
"identifiable",
"export"
]
},
"totals": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"distributions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"question": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
},
"answered": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"value",
"count"
]
}
}
},
"required": [
"publicationId",
"version",
"question",
"answered",
"values"
]
}
},
"responseQuality": {
"type": "object",
"properties": {
"clear": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"flagged": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unknown": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"submitted": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"clear",
"flagged",
"unknown",
"submitted"
]
},
"includeFlagged": {
"type": "boolean"
},
"page": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"arrival": {
"type": "object",
"properties": {
"timeZone": {
"type": "string"
},
"latestSurvey": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"latestInterview": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"missingSurveyTime": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"missingInterviewTime": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"days": {
"type": "array",
"items": {
"type": "object",
"properties": {
"day": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"survey": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"interview": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"day",
"survey",
"interview"
]
}
}
},
"required": [
"timeZone",
"latestSurvey",
"latestInterview",
"missingSurveyTime",
"missingInterviewTime",
"days"
]
},
"reviews": {
"type": "object",
"properties": {
"ended": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"ready": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pending": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"attention": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"ended",
"ready",
"pending",
"attention"
]
},
"interviewPublications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
}
},
"required": [
"id",
"version",
"topics"
]
}
}
},
"required": [
"study",
"role",
"policy",
"totals",
"distributions",
"responseQuality",
"includeFlagged",
"page",
"arrival",
"reviews",
"interviewPublications"
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/responses
responses_list
Current project data policy intersects credential scopes on every call. Free text, transcripts and contacts require responses:identifiable. Zero-based pages: response list 50, text 20, evidence 5. Totals/arrival include flagged responses; includeFlagged filters rows/distributions/exports. Export excludes test/expired/deleted responses and fails with EXPORT_TOO_LARGE above 5,000 responses or 50,000 turns; no truncation.
Required scopes: responses:read
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
{
"name": "includeFlagged",
"in": "query",
"required": false,
"schema": {
"default": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "string",
"enum": [
"",
"unknown"
]
}
]
}
},
{
"name": "test",
"in": "query",
"required": false,
"schema": {
"default": "false",
"type": "string",
"enum": [
"true",
"false"
]
}
}
]Responses
{
"200": {
"description": "Authorized collection data; internal identity, credential and job lease fields are omitted.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"collecting",
"paused",
"closed"
]
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"auto_close": {
"type": "boolean"
},
"survey_goal": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"interview_goal": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"survey_completed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"interview_completed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"starts_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ends_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"survey_closed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"interview_closed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"archived_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"project_id",
"title",
"kind",
"status",
"version",
"auto_close",
"survey_goal",
"interview_goal",
"survey_completed",
"interview_completed",
"starts_at",
"ends_at",
"survey_closed_at",
"interview_closed_at",
"archived_at"
]
},
"role": {
"type": "string",
"enum": [
"admin",
"editor",
"viewer"
]
},
"policy": {
"type": "object",
"properties": {
"aggregate": {
"type": "boolean"
},
"raw": {
"type": "boolean"
},
"identifiable": {
"type": "boolean"
},
"export": {
"type": "boolean"
}
},
"required": [
"aggregate",
"raw",
"identifiable",
"export"
]
},
"totals": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"distributions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"question": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
},
"answered": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"value",
"count"
]
}
}
},
"required": [
"publicationId",
"version",
"question",
"answered",
"values"
]
}
},
"responseQuality": {
"type": "object",
"properties": {
"clear": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"flagged": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unknown": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"submitted": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"clear",
"flagged",
"unknown",
"submitted"
]
},
"includeFlagged": {
"type": "boolean"
},
"page": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"publication_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"is_test": {
"type": "boolean"
},
"survey_state": {
"type": "string",
"enum": [
"idle",
"active",
"completed"
]
},
"interview_state": {
"type": "string",
"enum": [
"idle",
"active",
"completed",
"participant_stop",
"time_limit",
"collection_closed",
"technical_error"
]
},
"started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_active_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"retention_until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"response_quality": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"clear",
"flagged",
"unknown",
"off"
]
},
"flags": {
"type": "array",
"items": {
"type": "string",
"enum": [
"repeat",
"reverse"
]
}
},
"repeat": {
"type": "object",
"properties": {
"evaluated": {
"type": "boolean"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"type": "string"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"percent": {
"type": "number"
},
"threshold": {
"type": "number"
}
},
"required": [
"group",
"total",
"position",
"count",
"percent",
"threshold"
]
}
}
},
"required": [
"evaluated",
"groups"
]
},
"reverse": {
"type": "object",
"properties": {
"evaluated": {
"type": "boolean"
},
"pairs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string"
},
"baseId": {
"type": "string"
},
"difference": {
"type": "number"
},
"threshold": {
"type": "number"
}
},
"required": [
"questionId",
"baseId",
"difference",
"threshold"
]
}
}
},
"required": [
"evaluated",
"pairs"
]
}
},
"required": [
"status",
"flags",
"repeat",
"reverse"
]
},
{
"type": "null"
}
]
},
"survey_elapsed_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"publication_id",
"version",
"is_test",
"survey_state",
"interview_state",
"started_at",
"last_active_at",
"retention_until",
"response_quality",
"survey_elapsed_seconds"
]
}
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"qid": {
"type": "string"
},
"reached": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"abandoned": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"qid",
"reached",
"abandoned"
]
}
},
"forecast": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"study",
"role",
"policy",
"totals",
"distributions",
"responseQuality",
"includeFlagged",
"page",
"rows",
"questions",
"forecast"
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/responses/{response}
response_read
Current project data policy intersects credential scopes on every call. Free text, transcripts and contacts require responses:identifiable. Zero-based pages: response list 50, text 20, evidence 5. Totals/arrival include flagged responses; includeFlagged filters rows/distributions/exports. Export excludes test/expired/deleted responses and fails with EXPORT_TOO_LARGE above 5,000 responses or 50,000 turns; no truncation.
Required scopes: responses:read
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "response",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "test",
"in": "query",
"required": false,
"schema": {
"default": "false",
"type": "string",
"enum": [
"true",
"false"
]
}
}
]Responses
{
"200": {
"description": "Authorized collection data; internal identity, credential and job lease fields are omitted.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"policy": {
"type": "object",
"properties": {
"aggregate": {
"type": "boolean"
},
"raw": {
"type": "boolean"
},
"identifiable": {
"type": "boolean"
},
"export": {
"type": "boolean"
}
},
"required": [
"aggregate",
"raw",
"identifiable",
"export"
]
},
"detail": {
"type": "object",
"properties": {
"session": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"publication_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"is_test": {
"type": "boolean"
},
"survey_state": {
"type": "string",
"enum": [
"idle",
"active",
"completed"
]
},
"interview_state": {
"type": "string",
"enum": [
"idle",
"active",
"completed",
"participant_stop",
"time_limit",
"collection_closed",
"technical_error"
]
},
"started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_active_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"retention_until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"response_quality": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"clear",
"flagged",
"unknown",
"off"
]
},
"flags": {
"type": "array",
"items": {
"type": "string",
"enum": [
"repeat",
"reverse"
]
}
},
"repeat": {
"type": "object",
"properties": {
"evaluated": {
"type": "boolean"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"type": "string"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"percent": {
"type": "number"
},
"threshold": {
"type": "number"
}
},
"required": [
"group",
"total",
"position",
"count",
"percent",
"threshold"
]
}
}
},
"required": [
"evaluated",
"groups"
]
},
"reverse": {
"type": "object",
"properties": {
"evaluated": {
"type": "boolean"
},
"pairs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string"
},
"baseId": {
"type": "string"
},
"difference": {
"type": "number"
},
"threshold": {
"type": "number"
}
},
"required": [
"questionId",
"baseId",
"difference",
"threshold"
]
}
}
},
"required": [
"evaluated",
"pairs"
]
}
},
"required": [
"status",
"flags",
"repeat",
"reverse"
]
},
{
"type": "null"
}
]
},
"survey_elapsed_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"study_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"transfer_consent": {
"type": "boolean"
},
"current_question_id": {
"type": [
"string",
"null"
]
},
"survey_revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"survey_edited_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"survey_completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"interview_completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"interview_started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"interview_eligible": {
"type": "boolean"
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"submitted_answers": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"source_answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"source_questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"reward_contact_state": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
}
},
"required": [
"id",
"publication_id",
"version",
"is_test",
"survey_state",
"interview_state",
"started_at",
"last_active_at",
"retention_until",
"response_quality",
"survey_elapsed_seconds",
"study_id",
"transfer_consent",
"current_question_id",
"survey_revision",
"survey_edited_at",
"survey_completed_at",
"interview_completed_at",
"interview_started_at",
"interview_eligible",
"answers",
"submitted_answers",
"source_questions",
"reward_contact_state"
]
},
"publication": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"settings": {
"type": "object",
"properties": {
"languages": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
"voiceInput": {
"type": "boolean"
},
"quality": {
"type": "object",
"properties": {
"repeatEnabled": {
"type": "boolean"
},
"repeatPercent": {
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minAnswers": {
"type": "integer",
"minimum": 5,
"maximum": 100
},
"reverseEnabled": {
"type": "boolean"
},
"reverse5": {
"type": "integer",
"minimum": 1,
"maximum": 4
},
"reverse7": {
"type": "integer",
"minimum": 1,
"maximum": 6
},
"blockInterview": {
"type": "boolean"
},
"blockLinked": {
"type": "boolean"
}
},
"required": [
"repeatEnabled",
"repeatPercent",
"minAnswers",
"reverseEnabled",
"reverse5",
"reverse7",
"blockInterview",
"blockLinked"
]
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"autoClose": {
"default": false,
"type": "boolean"
},
"surveyGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"interviewGoal": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
{
"type": "null"
}
]
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"notice": {
"type": "string"
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"acknowledgedWarnings": {
"default": [],
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"startsAt",
"endsAt",
"surveyGoal",
"interviewGoal",
"retentionUntil",
"notice"
]
},
"is_test": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"study_id",
"version",
"design",
"settings",
"is_test",
"created_at"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sequence": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"role": {
"type": "string",
"enum": [
"participant",
"interviewer"
]
},
"content": {
"type": "string"
},
"topic_id": {
"type": [
"string",
"null"
]
},
"action": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"reason_codes": {
"type": "array",
"items": {
"type": "string"
}
},
"source_turn_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"id",
"sequence",
"role",
"content",
"topic_id",
"action",
"created_at",
"reason_codes",
"source_turn_ids"
]
}
},
"evidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"topic_id": {
"type": "string"
},
"target_id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"covered",
"partial",
"unasked",
"unconfirmed",
"unknown",
"not_applicable",
"refused",
"time_limit",
"probe_limit"
]
},
"nature": {
"anyOf": [
{
"type": "string",
"enum": [
"experience",
"opinion",
"wish",
"plan",
"hypothesis",
"uncertain"
]
},
{
"type": "null"
}
]
},
"turn_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"answer_id": {
"type": [
"string",
"null"
]
},
"quote_start": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"quote_end": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"summary": {
"type": "string"
},
"supersedes": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"topic_id",
"target_id",
"state",
"nature",
"turn_id",
"quote_start",
"quote_end",
"summary",
"supersedes"
]
}
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"state": {
"type": "string"
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"state",
"error_code"
]
}
},
"recordReview": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"source_version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"prompt_version": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"ready",
"budget_wait",
"failed",
"unknown",
"cancelled"
]
},
"canRetry": {
"type": "boolean"
},
"result": {
"anyOf": [
{
"type": "object",
"properties": {
"evidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"topic_id": {
"type": "string"
},
"target_id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"covered",
"partial",
"unasked",
"unconfirmed",
"unknown",
"not_applicable",
"refused",
"time_limit",
"probe_limit"
]
},
"nature": {
"anyOf": [
{
"type": "string",
"enum": [
"experience",
"opinion",
"wish",
"plan",
"hypothesis",
"uncertain"
]
},
{
"type": "null"
}
]
},
"turn_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"answer_id": {
"type": [
"string",
"null"
]
},
"quote_start": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"quote_end": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"summary": {
"type": "string"
},
"supersedes": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"topic_id",
"target_id",
"state",
"nature",
"turn_id",
"quote_start",
"quote_end",
"summary",
"supersedes"
]
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"topicId": {
"type": "string"
},
"targetId": {
"type": "string"
},
"reason": {
"type": "string"
},
"previousIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"topicId",
"targetId",
"reason",
"previousIds"
]
}
}
},
"required": [
"evidence",
"changes"
]
},
{
"type": "null"
}
]
},
"error_code": {
"type": [
"string",
"null"
]
},
"completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"source_version",
"prompt_version",
"state",
"canRetry",
"result",
"error_code",
"completed_at"
]
},
{
"type": "null"
}
]
},
"restricted": {
"default": false,
"type": "boolean"
}
},
"required": [
"session",
"publication",
"turns",
"evidence",
"jobs"
]
}
},
"required": [
"policy",
"detail"
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/responses/text
responses_text
Current project data policy intersects credential scopes on every call. Free text, transcripts and contacts require responses:identifiable. Zero-based pages: response list 50, text 20, evidence 5. Totals/arrival include flagged responses; includeFlagged filters rows/distributions/exports. Export excludes test/expired/deleted responses and fails with EXPORT_TOO_LARGE above 5,000 responses or 50,000 turns; no truncation.
Required scopes: responses:read + responses:identifiable
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
{
"name": "includeFlagged",
"in": "query",
"required": false,
"schema": {
"default": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "string",
"enum": [
"",
"unknown"
]
}
]
}
},
{
"name": "publicationId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "questionId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"default": "recent",
"type": "string",
"enum": [
"recent",
"oldest"
]
}
}
]Responses
{
"200": {
"description": "Authorized collection data; internal identity, credential and job lease fields are omitted.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"value": {
"type": "string"
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"responseId",
"value",
"createdAt"
]
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"rows",
"total",
"page"
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/results/evidence
results_evidence
Current project data policy intersects credential scopes on every call. Free text, transcripts and contacts require responses:identifiable. Zero-based pages: response list 50, text 20, evidence 5. Totals/arrival include flagged responses; includeFlagged filters rows/distributions/exports. Export excludes test/expired/deleted responses and fails with EXPORT_TOO_LARGE above 5,000 responses or 50,000 turns; no truncation.
Required scopes: responses:read + responses:identifiable
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "string",
"enum": [
"",
"unknown"
]
}
]
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
{
"name": "publicationId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
{
"name": "targetId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
{
"name": "source",
"in": "query",
"required": false,
"schema": {
"default": "reviewed",
"type": "string",
"enum": [
"reviewed",
"original"
]
}
}
]Responses
{
"200": {
"description": "Authorized collection data; internal identity, credential and job lease fields are omitted.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"participants": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"states": {
"type": "array",
"items": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"state",
"count"
]
}
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"completedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ending": {
"type": "string",
"enum": [
"idle",
"active",
"completed",
"participant_stop",
"time_limit",
"collection_closed",
"technical_error"
]
},
"evidence": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"topic_id": {
"type": "string"
},
"target_id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"covered",
"partial",
"unasked",
"unconfirmed",
"unknown",
"not_applicable",
"refused",
"time_limit",
"probe_limit"
]
},
"nature": {
"anyOf": [
{
"type": "string",
"enum": [
"experience",
"opinion",
"wish",
"plan",
"hypothesis",
"uncertain"
]
},
{
"type": "null"
}
]
},
"turn_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"answer_id": {
"type": [
"string",
"null"
]
},
"quote_start": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"quote_end": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"summary": {
"type": "string"
},
"supersedes": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"topic_id",
"target_id",
"state",
"nature",
"turn_id",
"quote_start",
"quote_end",
"summary",
"supersedes"
]
},
"quote": {
"type": [
"string",
"null"
]
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"topicId": {
"type": "string"
},
"targetId": {
"type": "string"
},
"reason": {
"type": "string"
},
"previousIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"topicId",
"targetId",
"reason",
"previousIds"
]
}
}
},
"required": [
"responseId",
"completedAt",
"ending",
"evidence",
"quote",
"changes"
]
}
}
},
"required": [
"total",
"participants",
"states",
"rows"
]
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/responses/export
responses_export
Current project data policy intersects credential scopes on every call. Free text, transcripts and contacts require responses:identifiable. Zero-based pages: response list 50, text 20, evidence 5. Totals/arrival include flagged responses; includeFlagged filters rows/distributions/exports. Export excludes test/expired/deleted responses and fails with EXPORT_TOO_LARGE above 5,000 responses or 50,000 turns; no truncation.
Required scopes: responses:read + responses:export
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeFlagged",
"in": "query",
"required": false,
"schema": {
"default": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "string",
"enum": [
"",
"unknown"
]
}
]
}
},
{
"name": "parts",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"default": "json",
"type": "string",
"enum": [
"json",
"xlsx"
]
}
}
]Responses
{
"200": {
"description": "Authorized collection data; internal identity, credential and job lease fields are omitted.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"language": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "string",
"enum": [
"",
"unknown"
]
}
]
},
"exportedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"responseCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"turnCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"identifiable": {
"type": "boolean"
},
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
]
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"design": {
"type": "object",
"properties": {
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
}
},
"required": [
"topics"
]
}
},
"required": [
"questions",
"guide"
]
}
},
"required": [
"id",
"version",
"design"
]
}
},
"responses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"surveyState": {
"type": "string",
"enum": [
"idle",
"active",
"completed"
]
},
"interviewState": {
"type": "string",
"enum": [
"idle",
"active",
"completed",
"participant_stop",
"time_limit",
"collection_closed",
"technical_error"
]
},
"surveyCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"interviewCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality": {
"type": [
"string",
"null"
]
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"review": {
"anyOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"queued",
"running",
"ready",
"budget_wait",
"failed",
"unknown",
"cancelled"
]
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"completedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"result": {
"anyOf": [
{
"type": "object",
"properties": {
"evidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"topic_id": {
"type": "string"
},
"target_id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"covered",
"partial",
"unasked",
"unconfirmed",
"unknown",
"not_applicable",
"refused",
"time_limit",
"probe_limit"
]
},
"nature": {
"anyOf": [
{
"type": "string",
"enum": [
"experience",
"opinion",
"wish",
"plan",
"hypothesis",
"uncertain"
]
},
{
"type": "null"
}
]
},
"turn_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"answer_id": {
"type": [
"string",
"null"
]
},
"quote_start": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"quote_end": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"summary": {
"type": "string"
},
"supersedes": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"topic_id",
"target_id",
"state",
"nature",
"turn_id",
"quote_start",
"quote_end",
"summary",
"supersedes"
]
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"topicId": {
"type": "string"
},
"targetId": {
"type": "string"
},
"reason": {
"type": "string"
},
"previousIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"topicId",
"targetId",
"reason",
"previousIds"
]
}
}
},
"required": [
"evidence",
"changes"
]
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"sourceVersion",
"completedAt",
"result"
]
},
{
"type": "null"
}
]
},
"original": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"topic_id": {
"type": "string"
},
"target_id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"covered",
"partial",
"unasked",
"unconfirmed",
"unknown",
"not_applicable",
"refused",
"time_limit",
"probe_limit"
]
},
"nature": {
"anyOf": [
{
"type": "string",
"enum": [
"experience",
"opinion",
"wish",
"plan",
"hypothesis",
"uncertain"
]
},
{
"type": "null"
}
]
},
"turn_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"answer_id": {
"type": [
"string",
"null"
]
},
"quote_start": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"quote_end": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"summary": {
"type": "string"
},
"supersedes": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"quote": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"topic_id",
"target_id",
"state",
"nature",
"turn_id",
"quote_start",
"quote_end",
"summary",
"supersedes",
"quote"
]
}
}
},
"required": [
"id",
"publicationId",
"version",
"surveyState",
"interviewState",
"surveyCompletedAt",
"interviewCompletedAt",
"quality",
"answers",
"review",
"original"
]
}
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sequence": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"role": {
"type": "string",
"enum": [
"participant",
"interviewer"
]
},
"content": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"responseId",
"id",
"sequence",
"role",
"content",
"createdAt"
]
}
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"consentAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"retentionUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"responseId",
"name",
"phone",
"email",
"consentAt",
"retentionUntil"
]
}
}
},
"required": [
"exportedAt",
"responseCount",
"turnCount",
"identifiable",
"study",
"publications",
"responses",
"turns",
"contacts"
]
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{id}/responses/{response}/review
record_review_status
Required scopes: responses:review
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "response",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "version",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]Responses
{
"200": {
"description": "Current review metadata only. Evidence and transcripts use the separately authorized response/evidence API.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"review": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sourceVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"promptVersion": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"ready",
"budget_wait",
"failed",
"unknown",
"cancelled"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"completedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"retryAfter": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"errorCode": {
"type": [
"string",
"null"
]
},
"canRetry": {
"type": "boolean"
}
},
"required": [
"id",
"responseId",
"sourceVersion",
"promptVersion",
"status",
"createdAt",
"completedAt",
"retryAfter",
"errorCode",
"canRetry"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"review"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{id}/responses/{response}/review
record_review_request
Explicitly enqueue/retry an ended record at the reviewed source version. Current admin/editor raw and identifiable project permissions are required. Reuse the exact request UUID/body after a lost response; the same receipt never requeues a failed job. A new deliberate retry uses a new UUID; unknown costs and the existing two-attempt ceiling remain enforced.
Required scopes: responses:review
Parameters
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "response",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"version",
"requestId",
"confirm"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current review metadata only. Evidence and transcripts use the separately authorized response/evidence API.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"review": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sourceVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"promptVersion": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"ready",
"budget_wait",
"failed",
"unknown",
"cancelled"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"completedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"retryAfter": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"errorCode": {
"type": [
"string",
"null"
]
},
"canRetry": {
"type": "boolean"
}
},
"required": [
"id",
"responseId",
"sourceVersion",
"promptVersion",
"status",
"createdAt",
"completedAt",
"retryAfter",
"errorCode",
"canRetry"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"review"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{study}/assets
asset_list
Required scopes: studies:read / studies:write
Parameters
[
{
"name": "study",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Responses
{
"200": {
"description": "All study assets (at most 20).",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"content_hash": {
"type": [
"string",
"null"
]
},
"state": {
"type": "string",
"enum": [
"uploading",
"reading",
"ready",
"partial",
"failed",
"deleting"
]
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"segment",
"text"
],
"additionalProperties": false
}
},
"error_code": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"study_id",
"name",
"mime",
"bytes",
"content_hash",
"state",
"extracted",
"error_code",
"created_at",
"reviewHash"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/studies/{study}/assets/{asset}
asset_read
Required scopes: studies:read / studies:write
Parameters
[
{
"name": "study",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "asset",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Responses
{
"200": {
"description": "Private metadata. Issued download links remain valid for 60 seconds.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"asset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"content_hash": {
"type": [
"string",
"null"
]
},
"state": {
"type": "string",
"enum": [
"uploading",
"reading",
"ready",
"partial",
"failed",
"deleting"
]
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"segment",
"text"
],
"additionalProperties": false
}
},
"error_code": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"study_id",
"name",
"mime",
"bytes",
"content_hash",
"state",
"extracted",
"error_code",
"created_at",
"reviewHash"
],
"additionalProperties": false
},
"downloadUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"downloadExpiresIn": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"asset",
"downloadUrl",
"downloadExpiresIn"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}PUT/studies/{study}/assets/{asset}
asset_prepare
Retry the stable asset UUID and exact metadata. PUT bytes to uploadUrl without an API bearer. Upload links last two hours.
Required scopes: studies:write
Parameters
[
{
"name": "study",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "asset",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"mime": {
"type": "string",
"enum": [
"application/pdf",
"text/plain",
"text/markdown",
"image/png",
"image/jpeg",
"image/webp",
"video/mp4",
"video/webm"
]
},
"bytes": {
"type": "integer",
"minimum": 1,
"maximum": 52428800
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"name",
"mime",
"bytes",
"sha256"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Private upload prepared.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"asset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"content_hash": {
"type": [
"string",
"null"
]
},
"state": {
"type": "string",
"enum": [
"uploading",
"reading",
"ready",
"partial",
"failed",
"deleting"
]
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"segment",
"text"
],
"additionalProperties": false
}
},
"error_code": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"study_id",
"name",
"mime",
"bytes",
"content_hash",
"state",
"extracted",
"error_code",
"created_at",
"reviewHash"
],
"additionalProperties": false
},
"uploadUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"uploadExpiresIn": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"asset",
"uploadUrl",
"uploadExpiresIn"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}DELETE/studies/{study}/assets/{asset}
asset_delete
Review metadata first. Submit its reviewHash and explicit confirmation. Publication references block deletion. Storage cleanup is verified after outstanding upload links expire.
Required scopes: studies:write
Parameters
[
{
"name": "study",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "asset",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"reviewHash",
"confirm"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Removed from study; storage cleanup queued.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"deleted": {
"type": "boolean",
"const": true
},
"storageCleanup": {
"type": "string",
"enum": [
"pending",
"complete"
]
}
},
"required": [
"id",
"deleted",
"storageCleanup"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}POST/studies/{study}/assets/{asset}/complete
asset_complete
Required scopes: studies:write
Parameters
[
{
"name": "study",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "asset",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Content verified without AI. Check asset.state and error_code; failed files are queued for deletion.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"asset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"content_hash": {
"type": [
"string",
"null"
]
},
"state": {
"type": "string",
"enum": [
"uploading",
"reading",
"ready",
"partial",
"failed",
"deleting"
]
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"segment",
"text"
],
"additionalProperties": false
}
},
"error_code": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"reviewHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"study_id",
"name",
"mime",
"bytes",
"content_hash",
"state",
"extracted",
"error_code",
"created_at",
"reviewHash"
],
"additionalProperties": false
}
},
"required": [
"asset"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "application/problem+json with code, status and requestId. 401 invalid key; 403 scope/authority; 404 absent; 409 current policy required; 422 invalid input; 429 honor Retry-After; 503 unavailable.",
"content": {
"application/problem+json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"additionalProperties": false
}
}
}
}
}GET/service/settings
service_settings_read
Read personal, team or project settings and current version. Team/project settings also require workspace:read.
Required scopes: account:read / workspace:read
Parameters
[
{
"name": "scope",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"team",
"project",
"personal"
]
}
},
{
"name": "target",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scope": {
"type": "string",
"enum": [
"personal",
"team",
"project"
]
},
"role": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"email": {
"type": "string"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"timeZone": {
"type": "string"
},
"description": {
"type": "string"
},
"visibility": {
"type": "string",
"enum": [
"team",
"invite"
]
},
"archived": {
"type": "boolean"
},
"ownerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"collectingCount": {
"type": "number"
},
"studyCount": {
"type": "number"
},
"ownershipTransfer": {}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/settings
service_settings_write
Create teams/projects; save their settings; archive/restore projects. Personal settings use account:write instead of workspace:write.
Required scopes: account:write / workspace:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"archive",
"restore"
]
},
"scope": {
"type": "string",
"const": "project"
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"collectingCount": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
}
},
"required": [
"action",
"scope",
"target",
"version",
"collectingCount"
],
"additionalProperties": false
},
{
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "save"
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"scope": {
"type": "string",
"const": "team"
},
"patch": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"action",
"target",
"version",
"scope",
"patch"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "save"
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"scope": {
"type": "string",
"const": "project"
},
"patch": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"visibility": {
"type": "string",
"enum": [
"invite",
"team"
]
}
},
"required": [
"name",
"description",
"visibility"
],
"additionalProperties": false
}
},
"required": [
"action",
"target",
"version",
"scope",
"patch"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "save"
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"scope": {
"type": "string",
"const": "personal"
},
"patch": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"timeZone": {
"type": "string",
"maxLength": 100
}
},
"required": [
"name",
"locale",
"timeZone"
],
"additionalProperties": false
}
},
"required": [
"action",
"target",
"version",
"scope",
"patch"
],
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "create"
},
"scope": {
"type": "string",
"const": "team"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
}
},
"required": [
"action",
"scope",
"id",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "create"
},
"scope": {
"type": "string",
"const": "project"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"team": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"action",
"scope",
"id",
"name",
"team"
],
"additionalProperties": false
}
]
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scope": {
"type": "string",
"enum": [
"personal",
"team",
"project"
]
},
"role": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"email": {
"type": "string"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"timeZone": {
"type": "string"
},
"description": {
"type": "string"
},
"visibility": {
"type": "string",
"enum": [
"team",
"invite"
]
},
"archived": {
"type": "boolean"
},
"ownerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"collectingCount": {
"type": "number"
},
"studyCount": {
"type": "number"
},
"ownershipTransfer": {}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/members
service_members_read
List members or eligible project-member candidates. Native role and project visibility rules apply.
Required scopes: members:read
Parameters
[
{
"name": "scope",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"team",
"project"
]
}
},
{
"name": "target",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"default": "",
"type": "string",
"maxLength": 160
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
{
"name": "candidates",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"page": {
"type": "number"
},
"pageSize": {
"type": "number"
},
"total": {
"type": "number"
},
"memberCount": {
"type": "number"
},
"roleCounts": {
"type": "object",
"properties": {
"admin": {
"type": "number"
},
"editor": {
"type": "number"
},
"viewer": {
"type": "number"
}
},
"additionalProperties": {}
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/members
service_members_write
Add project members, change a role, remove a member or leave by removing yourself. Use current version.
Required scopes: members:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"user": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"role",
"remove",
"add"
]
},
"role": {
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"admin",
"member",
"editor",
"viewer"
]
},
{
"type": "null"
}
]
}
},
"required": [
"scope",
"target",
"version",
"user",
"action"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"page": {
"type": "number"
},
"pageSize": {
"type": "number"
},
"total": {
"type": "number"
},
"memberCount": {
"type": "number"
},
"roleCounts": {
"type": "object",
"properties": {
"admin": {
"type": "number"
},
"editor": {
"type": "number"
},
"viewer": {
"type": "number"
}
},
"additionalProperties": {}
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/invitations
service_invitations_read
Read sent invitations or your inbox. No email invitations are sent.
Required scopes: invitations:write
Parameters
[
{
"name": "scope",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"team",
"project"
]
}
},
{
"name": "target",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
{
"name": "inbox",
"in": "query",
"required": false,
"schema": {
"type": "string",
"const": "true"
}
},
{
"name": "manual",
"in": "query",
"required": false,
"schema": {
"type": "string",
"const": "true"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"pageSize": {
"type": "number"
},
"checked": {
"type": "boolean"
},
"invitations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
},
{
"type": "null"
}
]
},
"recipient": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"cancelled": {
"type": "boolean"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/invitations
service_invitations_write
Look up registered recipients, invite, cancel, accept or decline. Lookup does not grant access or disclose external profile details.
Required scopes: invitations:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "lookup"
},
"email": {
"type": "string"
}
},
"required": [
"scope",
"target",
"action",
"email"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "send"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"email": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"member",
"viewer"
]
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectRole": {
"type": "string",
"enum": [
"admin",
"editor",
"viewer"
]
}
},
"required": [
"scope",
"target",
"action",
"id",
"version",
"email",
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "cancel"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"scope",
"target",
"action",
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "accept"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"action",
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "decline"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"action",
"id"
],
"additionalProperties": false
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"pageSize": {
"type": "number"
},
"checked": {
"type": "boolean"
},
"invitations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
},
{
"type": "null"
}
]
},
"recipient": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"cancelled": {
"type": "boolean"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/ownership
service_ownership_write
Request, accept, decline or cancel team ownership transfer. Acceptance requires explicit acknowledgment.
Required scopes: members:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "request"
},
"team": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"request": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"recipient": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"action",
"team",
"version",
"request",
"recipient"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "accept"
},
"team": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"request": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"acknowledged": {
"type": "boolean",
"const": true
}
},
"required": [
"action",
"team",
"version",
"request",
"acknowledged"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"decline",
"cancel"
]
},
"team": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"request": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"action",
"team",
"version",
"request"
],
"additionalProperties": false
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scope": {
"type": "string",
"const": "team"
},
"role": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"ownershipTransfer": {}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/data-access
service_data_access_read
Read the current project data visibility policy and paginated change history.
Required scopes: members:read
Parameters
[
{
"name": "project",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"teamVersion": {
"type": "number"
},
"policy": {},
"history": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/data-access
service_data_access_write
Save current role/data visibility rules with project/team versions and change reason.
Required scopes: members:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"project": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"teamVersion": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"request": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"policy": {
"type": "object",
"properties": {
"admin": {
"type": "object",
"properties": {
"aggregate": {
"type": "boolean"
},
"raw": {
"type": "boolean"
},
"identifiable": {
"type": "boolean"
},
"export": {
"type": "boolean"
}
},
"required": [
"aggregate",
"raw",
"identifiable",
"export"
],
"additionalProperties": false
},
"editor": {
"type": "object",
"properties": {
"aggregate": {
"type": "boolean"
},
"raw": {
"type": "boolean"
},
"identifiable": {
"type": "boolean"
},
"export": {
"type": "boolean"
}
},
"required": [
"aggregate",
"raw",
"identifiable",
"export"
],
"additionalProperties": false
},
"viewer": {
"type": "object",
"properties": {
"aggregate": {
"type": "boolean"
},
"raw": {
"type": "boolean"
},
"identifiable": {
"type": "boolean"
},
"export": {
"type": "boolean"
}
},
"required": [
"aggregate",
"raw",
"identifiable",
"export"
],
"additionalProperties": false
}
},
"required": [
"admin",
"editor",
"viewer"
],
"additionalProperties": false
},
"reason": {
"type": "string",
"minLength": 1
}
},
"required": [
"project",
"version",
"teamVersion",
"request",
"policy",
"reason"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"teamVersion": {
"type": "number"
},
"policy": {},
"history": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/notifications
service_notifications_read
Read your notification preferences.
Required scopes: account:read
Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"mentions": {
"type": "boolean"
},
"collection": {
"type": "boolean"
},
"digest": {
"type": "boolean"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/notifications
service_notifications_write
Save one notification preference with current version.
Required scopes: account:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"field": {
"type": "string",
"enum": [
"mentions",
"collection",
"digest"
]
},
"enabled": {
"type": "boolean"
}
},
"required": [
"version",
"field",
"enabled"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"mentions": {
"type": "boolean"
},
"collection": {
"type": "boolean"
},
"digest": {
"type": "boolean"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/account
service_account_read
Read your privacy settings and consent history. Authentication method and session management are excluded.
Required scopes: account:read
Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"marketingEmail": {
"type": "boolean"
},
"marketingUpdatedAt": {
"type": [
"string",
"null"
]
},
"timeZone": {
"type": "string"
},
"policy": {
"type": "object",
"properties": {
"hash": {
"type": "string"
},
"version": {
"type": "string"
},
"acceptedAt": {
"type": "string"
},
"documents": {}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/account
service_account_write
Change optional email consent; mandatory accepted policies are preserved.
Required scopes: account:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"request": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"type": "boolean"
},
"noticeVersion": {
"type": "string",
"const": "email-marketing-2026-09-19"
}
},
"required": [
"version",
"request",
"enabled",
"noticeVersion"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "number"
},
"marketingEmail": {
"type": "boolean"
},
"marketingUpdatedAt": {
"type": [
"string",
"null"
]
},
"timeZone": {
"type": "string"
},
"policy": {
"type": "object",
"properties": {
"hash": {
"type": "string"
},
"version": {
"type": "string"
},
"acceptedAt": {
"type": "string"
},
"documents": {}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/usage
service_usage_read
Read existing free-service storage usage. This is not a payment or subscription API.
Required scopes: workspace:read
Parameters
[
{
"name": "team",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"page": {
"type": "number"
},
"usage": {},
"projects": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/team-ai
service_team_ai_read
Read AI availability, current usage, support balance and your requests. BYOK configuration is excluded.
Required scopes: workspace:read
Parameters
[
{
"name": "team",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"budget": {},
"requests": {
"type": "array",
"items": {}
},
"usage": {},
"canManage": {
"type": "boolean"
},
"credit": {
"type": "object",
"properties": {
"granted": {
"type": "number"
},
"spent": {
"type": "number"
},
"held": {
"type": "number"
},
"available": {
"type": "number"
}
},
"additionalProperties": {}
},
"features": {
"type": "array",
"items": {}
},
"grants": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/team-ai
service_team_ai_write
Request or cancel existing AI support. No payment or provider call is made.
Required scopes: support:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"purpose": {
"type": "string",
"minLength": 5,
"maxLength": 2000
},
"scale": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"cancel": {
"default": false,
"type": "boolean"
}
},
"required": [
"teamId",
"requestId",
"purpose",
"scale",
"until"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"budget": {},
"requests": {
"type": "array",
"items": {}
},
"usage": {},
"canManage": {
"type": "boolean"
},
"credit": {
"type": "object",
"properties": {
"granted": {
"type": "number"
},
"spent": {
"type": "number"
},
"held": {
"type": "number"
},
"available": {
"type": "number"
}
},
"additionalProperties": {}
},
"features": {
"type": "array",
"items": {}
},
"grants": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/retention
service_retention_read
Read retention and deletion counts for a project.
Required scopes: responses:read
Parameters
[
{
"name": "project",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"studies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"retentionUntil": {
"type": [
"string",
"null"
]
},
"count": {
"type": "number"
}
},
"additionalProperties": {}
}
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/retention
service_retention_write
Shorten retention after reviewing the affected count. Extensions are forbidden.
Required scopes: responses:delete
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 500
}
},
"required": [
"studyId",
"until",
"count",
"requestId",
"reason"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"studies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"retentionUntil": {
"type": [
"string",
"null"
]
},
"count": {
"type": "number"
}
},
"additionalProperties": {}
}
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/workspace-deletions
service_workspace_deletions_read
Preview the exact team/project deletion scope and review hash.
Required scopes: workspace:write
Parameters
[
{
"name": "scope",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"team",
"project"
]
}
},
{
"name": "target",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"review": {
"type": "string"
},
"projects": {
"type": "number"
},
"studies": {
"type": "number"
},
"active": {
"type": "number"
},
"surveyResponses": {
"type": "number"
},
"interviewResponses": {
"type": "number"
},
"storageCleanup": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/workspace-deletions
service_workspace_deletions_write
Permanently delete the reviewed team/project. Exact name, review hash and acknowledgment are required.
Required scopes: workspace:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"request": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"review": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"acknowledged": {
"type": "boolean",
"const": true
}
},
"required": [
"scope",
"target",
"request",
"review",
"name",
"acknowledged"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scope": {
"type": "string",
"enum": [
"team",
"project"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"review": {
"type": "string"
},
"projects": {
"type": "number"
},
"studies": {
"type": "number"
},
"active": {
"type": "number"
},
"surveyResponses": {
"type": "number"
},
"interviewResponses": {
"type": "number"
},
"storageCleanup": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/study-lifecycle
service_study_lifecycle_read
Read full current authoring state, assets and durable AI jobs/results/errors. Use this to inspect saved proposals and recover interrupted authoring before another paid request.
Required scopes: studies:read
Parameters
[
{
"name": "study",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"version": {
"type": "number"
},
"updated_at": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": {}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"role": {
"type": "string"
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"feature": {
"type": "string"
},
"state": {
"type": "string"
},
"result": {},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"archived": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"storageCleanup": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/study-lifecycle
service_study_lifecycle_write
Archive, restore or delete a study with its latest updatedAt. Restoring does not reopen collection.
Required scopes: studies:delete
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"archive",
"restore",
"delete"
]
},
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"action",
"studyId",
"updatedAt",
"requestId"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"version": {
"type": "number"
},
"updated_at": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": {}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"role": {
"type": "string"
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"feature": {
"type": "string"
},
"state": {
"type": "string"
},
"result": {},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"archived": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"storageCleanup": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}DELETE/service/response-deletion
service_response_deletion_write
Delete reviewed selected responses or all responses (ids=null), with exact count and reason.
Required scopes: responses:delete
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"ids": {
"anyOf": [
{
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"type": "null"
}
]
},
"count": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"studyId",
"ids",
"count",
"requestId",
"reason"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"deleted": {
"type": "number"
},
"storageCleanup": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/reward-contacts
service_reward_contacts_read
Read reward contacts by page; export permissions and project policy also apply.
Required scopes: responses:read + responses:export + responses:identifiable
Parameters
[
{
"name": "study",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "test",
"in": "query",
"required": false,
"schema": {
"default": "false",
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
{
"name": "download",
"in": "query",
"required": false,
"schema": {
"default": "false",
"type": "string",
"enum": [
"true",
"false"
]
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"saved": {
"type": "boolean"
},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"pageSize": {
"type": "number"
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"declined": {
"type": "boolean"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/reward-contacts
service_reward_contacts_write
Submit or decline reward contact collection for your current response.
Required scopes: participation:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"decline": {
"type": "boolean"
},
"consent": {
"type": "boolean"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 254
},
{
"type": "null"
}
]
},
"attemptId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"link",
"test",
"participationId",
"decline",
"consent",
"name",
"phone",
"email",
"attemptId"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"saved": {
"type": "boolean"
},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"pageSize": {
"type": "number"
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"declined": {
"type": "boolean"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/linked-study
service_linked_study_read
Read the eligible linked study and translated additional consent.
Required scopes: participation:write
Parameters
[
{
"name": "link",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "test",
"in": "query",
"required": false,
"schema": {
"default": "false",
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "locale",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
{
"name": "attemptId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"linked": {
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"purpose": {
"type": "string"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
"loginRequired": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"href": {
"type": "string"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/linked-study
service_linked_study_write
Start the eligible linked study after additional consent. Original response and chosen language are preserved.
Required scopes: participation:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"consent": {
"type": "boolean",
"const": true
},
"transferConsent": {
"type": "boolean"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"attemptId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"link",
"test",
"requestId",
"publicationId",
"consent",
"transferConsent",
"attemptId"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"linked": {
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"purpose": {
"type": "string"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
},
"loginRequired": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"href": {
"type": "string"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/interview
service_interview_write
Run the current text/voice interview or restart only its permitted latest answer. start/answer/skip/stop/retry require confirmCost=true. The existing durable interview_execute operation remains available for asynchronous text work.
Required scopes: participation:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"start",
"answer",
"skip",
"stop",
"pause",
"resume",
"retry"
]
},
"text": {
"default": "",
"type": "string",
"maxLength": 12000
},
"voiceAnswerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"voiceRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"requestId",
"action",
"attemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "restart"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"questionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"participationId",
"action",
"requestId",
"questionId",
"version",
"attemptId"
],
"additionalProperties": false
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/voice
service_voice_write
Open, upload chunks, inspect, review, continue, seal or detect the endpoint of your current voice answer. clip/review require confirmCost=true. Audio is base64 WAV, subject to existing limits.
Required scopes: participation:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "open"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mode": {
"type": "string",
"enum": [
"check",
"answer"
]
},
"consent": {
"type": "boolean",
"const": true
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"participationId",
"action",
"id",
"mode",
"consent",
"attemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"clip",
"archive"
]
},
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sequence": {
"type": "integer",
"minimum": 0,
"maximum": 199
},
"audio": {
"type": "string",
"maxLength": 860000
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"participationId",
"action",
"answerId",
"id",
"sequence",
"audio",
"attemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"get",
"review"
]
},
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"participationId",
"action",
"answerId",
"attemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "endpoint"
},
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"audio": {
"type": "string",
"minLength": 64,
"maxLength": 341392,
"pattern": "^[A-Za-z0-9+/]+={0,2}$"
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"participationId",
"action",
"answerId",
"audio",
"attemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "continue"
},
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"participationId",
"action",
"answerId",
"submissionId",
"requestId",
"attemptId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"link": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"test": {
"type": "boolean"
},
"participationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"const": "seal"
},
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"link",
"test",
"participationId",
"action",
"answerId",
"revision",
"attemptId"
],
"additionalProperties": false
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submission_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mode": {
"type": "string",
"enum": [
"check",
"answer"
]
},
"state": {
"type": "string"
},
"question_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"transcript": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"wait": {
"type": "boolean"
},
"revision": {
"type": "number"
},
"reviewed_revision": {
"type": "number"
},
"created_at": {
"type": "string"
},
"chunks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sequence": {
"type": "number"
},
"state": {
"type": "string"
},
"text": {
"type": "string"
},
"seconds": {
"type": "number"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
"state": {
"type": "object",
"properties": {
"locale": {
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "null"
}
]
},
"voiceContinuation": {
"anyOf": [
{
"type": "object",
"properties": {
"answerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"submissionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"turnId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"answerId",
"submissionId",
"turnId"
]
},
{
"type": "null"
}
]
},
"voiceInput": {
"type": "boolean"
},
"voiceChecked": {
"type": "boolean"
},
"voiceSummaries": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"loginRequired": {
"type": "boolean"
},
"preventDuplicates": {
"type": "boolean"
},
"allowResponseEdits": {
"type": "boolean"
},
"canEditResponse": {
"type": "boolean"
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"rewardContact": {
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
"rewardContactState": {
"type": "string",
"enum": [
"pending",
"submitted",
"declined"
]
},
"canRepeat": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"id",
"name",
"mime"
],
"additionalProperties": false
}
},
"topicAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"topicVideoLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"paused": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"unconfirmedCost": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"isTest": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"answers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
"currentQuestionId": {
"type": [
"string",
"null"
]
},
"submitted": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"selection": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 80
}
}
]
},
"other": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"selection",
"other"
],
"additionalProperties": false
},
{
"type": "string",
"maxLength": 10000
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"const": "na"
}
]
}
}
]
}
},
{
"type": "null"
}
]
},
"orderMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"surveyState": {
"type": "string"
},
"interviewState": {
"type": "string"
},
"interviewEligible": {
"type": "boolean"
},
"canStartInterview": {
"type": "boolean"
},
"notice": {
"type": "string"
},
"retentionUntil": {
"type": "string"
},
"transferConsent": {
"type": "boolean"
},
"transferQuestionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMinutes": {
"type": "number"
},
"interviewer": {
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"turns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"role": {
"type": "string"
},
"content": {
"type": "string"
},
"canRestart": {
"type": "boolean"
}
},
"required": [
"id",
"role",
"content"
],
"additionalProperties": false
}
},
"pending": {
"type": "boolean"
}
},
"required": [
"loginRequired",
"preventDuplicates",
"allowResponseEdits",
"canEditResponse",
"rewardContactState",
"canRepeat",
"assets",
"topicAssetIds",
"paused",
"canRetry",
"unconfirmedCost",
"id",
"version",
"publicationId",
"title",
"kind",
"isTest",
"closed",
"questions",
"answers",
"currentQuestionId",
"submitted",
"orderMap",
"surveyState",
"interviewState",
"interviewEligible",
"canStartInterview",
"notice",
"retentionUntil",
"transferConsent",
"transferQuestionIds",
"targetMinutes",
"turns",
"pending"
],
"additionalProperties": false
},
"endpoint": {
"type": "object",
"properties": {
"probability": {
"type": "number"
},
"elapsedMs": {
"type": "number"
}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/voice-files
service_voice_files_read
List authorized original voice files. Supply up to 50 comma-separated answer IDs to download a ZIP (max 100MB). Requires responses:read and responses:identifiable.
Required scopes: responses:read + responses:export + responses:identifiable
Parameters
[
{
"name": "study",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"default": "",
"anyOf": [
{
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
{
"type": "string",
"enum": [
"",
"unknown"
]
}
]
}
},
{
"name": "test",
"in": "query",
"required": false,
"schema": {
"default": "false",
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 1000000
}
},
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 2000
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"responseId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"createdAt": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"seconds": {
"type": "number"
},
"bytes": {
"type": "number"
},
"question": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
},
"hasMore": {
"type": "boolean"
}
},
"additionalProperties": {}
}
},
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/translations
service_translations_read
Read sourceHash, source, prior baselines and every target language state/result. Compare source entries before queuing; ready translations require explicit review.
Required scopes: studies:read
Parameters
[
{
"name": "study",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceHash": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"rewardContact": {
"anyOf": [
{
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
{
"type": "null"
}
]
}
},
"required": [
"title",
"design",
"notice"
]
},
"languages": {
"anyOf": [
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"baselines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"source": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"rewardContact": {
"anyOf": [
{
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
{
"type": "null"
}
]
}
},
"required": [
"title",
"design",
"notice"
]
},
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"path",
"text"
]
}
}
},
"required": [
"locale",
"source",
"result"
]
}
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"source_hash": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"ready",
"failed",
"unknown"
]
},
"reviewed_at": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"path",
"text"
]
}
},
{
"type": "null"
}
]
},
"retryable": {
"type": "boolean"
},
"error_code": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"locale",
"source_hash",
"state",
"reviewed_at",
"result",
"retryable",
"error_code",
"updated_at"
]
}
}
},
"required": [
"sourceHash",
"source",
"translations"
],
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/translations
service_translations_write
Queue an explicitly confirmed translation or mark the current ready language reviewed. Queue requires confirmCost=true. Poll GET translations; unknown cost is never retried automatically.
Required scopes: studies:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"study": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"queue",
"review"
]
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"sourceHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"study",
"action",
"locale",
"sourceHash"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceHash": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"rewardContact": {
"anyOf": [
{
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
{
"type": "null"
}
]
}
},
"required": [
"title",
"design",
"notice"
]
},
"languages": {
"anyOf": [
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"baselines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"source": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"rewardContact": {
"anyOf": [
{
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
{
"type": "null"
}
]
}
},
"required": [
"title",
"design",
"notice"
]
},
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"path",
"text"
]
}
}
},
"required": [
"locale",
"source",
"result"
]
}
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"source_hash": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"ready",
"failed",
"unknown"
]
},
"reviewed_at": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"path",
"text"
]
}
},
{
"type": "null"
}
]
},
"retryable": {
"type": "boolean"
},
"error_code": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"locale",
"source_hash",
"state",
"reviewed_at",
"result",
"retryable",
"error_code",
"updated_at"
]
}
}
},
"required": [
"sourceHash",
"source",
"translations"
],
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/translations/preview
service_translations_preview_read
Preview changed and reused entry counts, current state and review status for every offered target language. No provider call or queue mutation is made.
Required scopes: studies:read
Parameters
[
{
"name": "study",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceHash": {
"type": "string"
},
"languages": {
"anyOf": [
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"state": {
"type": "string"
},
"reviewed": {
"type": "boolean"
},
"reused": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"pending": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"retryable": {
"type": "boolean"
}
},
"required": [
"locale",
"state",
"reviewed",
"reused",
"pending",
"retryable"
]
}
}
},
"required": [
"sourceHash",
"languages",
"targets"
]
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/translations/refresh
service_translations_refresh_write
Atomically queue every offered target at the reviewed sourceHash. Ready/running work is reused; unknown billed work remains blocked. confirmCost=true is required. Review every ready language before publication.
Required scopes: studies:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"study": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sourceHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"study",
"sourceHash"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceHash": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"rewardContact": {
"anyOf": [
{
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
{
"type": "null"
}
]
}
},
"required": [
"title",
"design",
"notice"
]
},
"languages": {
"anyOf": [
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"ko",
"en"
]
},
"default": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"languages": {
"minItems": 1,
"maxItems": 60,
"type": "array",
"items": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
}
}
},
"required": [
"source",
"default",
"languages"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"baselines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"source": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"rewardContact": {
"anyOf": [
{
"default": {
"enabled": false,
"fields": {
"name": true,
"phone": true,
"email": false
},
"introduction": "보상 지급에 필요한 연락처를 남겨 주세요.",
"noticeText": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"purpose": "참여 보상 지급 및 관련 안내",
"controller": "",
"retentionUntil": ""
},
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"fields": {
"default": {
"name": true,
"phone": true,
"email": false
},
"type": "object",
"properties": {
"name": {
"type": "boolean"
},
"phone": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
},
"required": [
"name",
"phone",
"email"
]
},
"introduction": {
"default": "보상 지급에 필요한 연락처를 남겨 주세요.",
"type": "string",
"maxLength": 1000
},
"noticeText": {
"default": "수집한 연락처는 참여 보상 지급과 관련 안내에만 사용합니다. 보관 종료일이 지나면 삭제합니다.",
"type": "string",
"maxLength": 2000
},
"purpose": {
"default": "참여 보상 지급 및 관련 안내",
"type": "string",
"maxLength": 500
},
"controller": {
"default": "",
"type": "string",
"maxLength": 200
},
"retentionUntil": {
"default": "",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
}
},
{
"type": "null"
}
]
}
},
"required": [
"title",
"design",
"notice"
]
},
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"path",
"text"
]
}
}
},
"required": [
"locale",
"source",
"result"
]
}
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"locale": {
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"source_hash": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"ready",
"failed",
"unknown"
]
},
"reviewed_at": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"path",
"text"
]
}
},
{
"type": "null"
}
]
},
"retryable": {
"type": "boolean"
},
"error_code": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"locale",
"source_hash",
"state",
"reviewed_at",
"result",
"retryable",
"error_code",
"updated_at"
]
}
}
},
"required": [
"sourceHash",
"source",
"translations"
],
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/study-start
service_study_start_read
Read/list current authoring conversations, including archived history and cursor pagination.
Required scopes: studies:read
Parameters
[
{
"name": "projectId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "sessionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "list",
"in": "query",
"required": false,
"schema": {
"type": "string",
"const": "true"
}
},
{
"name": "archived",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"name": "studyId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "beforeAt",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
{
"name": "beforeId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"session": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"sessions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
},
"nextCursor": {},
"acquired": {
"type": "boolean"
},
"study": {
"type": "object",
"properties": {
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"version": {
"type": "number"
}
},
"additionalProperties": {}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
}
},
"additionalProperties": {}
},
"asset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
},
"signedUrl": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/study-start
service_study_start_write
Initialize, resume, recover, rename, move, archive or delete a conversation, prepare directly, send a consultation turn or create its study. Consultation prefers survey+interview unless user needs indicate otherwise, separates directionReady from designReady, and asks only consequential missing context. Relevant prior user statements are bounded, same-author/same-project reference material, never current facts. send or create with ai=true require ai:write and confirmCost=true.
Required scopes: studies:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "rename"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version",
"title"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "archive"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"archived": {
"type": "boolean"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version",
"archived"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "move"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"targetProjectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version",
"targetProjectId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "delete"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"confirmTitle": {
"type": "string",
"maxLength": 200
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version",
"confirmTitle"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"init",
"get",
"resume"
]
},
"sessionId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "recover"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "direct"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"kind": {
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"context": {
"type": "string",
"maxLength": 4000
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version",
"kind",
"purpose",
"context"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "send"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version",
"requestId",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "create"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"ai": {
"type": "boolean"
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"action",
"sessionId",
"projectId",
"version",
"requestId",
"studyId",
"ai"
],
"additionalProperties": false
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"session": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"sessions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
},
"nextCursor": {},
"acquired": {
"type": "boolean"
},
"study": {
"type": "object",
"properties": {
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"version": {
"type": "number"
}
},
"additionalProperties": {}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
}
},
"additionalProperties": {}
},
"asset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
},
"signedUrl": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/study-start/assets
service_study_start_assets_write
Prepare, finish or delete a conversation attachment. Upload to the returned signed URL without API credentials.
Required scopes: studies:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "prepare"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"mime": {
"type": "string",
"enum": [
"application/pdf",
"text/plain",
"text/markdown",
"image/png",
"image/jpeg",
"image/webp"
]
},
"bytes": {
"type": "integer",
"minimum": 1,
"maximum": 4194304
}
},
"required": [
"action",
"projectId",
"sessionId",
"version",
"assetId",
"name",
"mime",
"bytes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"finish",
"delete"
]
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"action",
"projectId",
"sessionId",
"version",
"assetId"
],
"additionalProperties": false
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"session": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"sessions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"actor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"consult",
"direct"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"survey",
"interview",
"combined"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
},
"context": {
"type": "string"
},
"pending_request": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"study_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": [
"string",
"null"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant"
]
},
"text": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": {}
}
},
"proposal": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"kind": {
"type": [
"string",
"null"
]
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
},
"ready": {
"type": "boolean"
},
"directionReady": {
"type": "boolean"
},
"designReady": {
"type": "boolean"
},
"nextQuestion": {
"type": "string"
},
"missingContext": {
"type": "array",
"items": {
"type": "string"
}
},
"factEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"quote": {
"type": "string"
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"bytes": {
"type": "number"
},
"state": {
"type": "string"
},
"extracted": {
"type": "array",
"items": {
"type": "object",
"properties": {
"segment": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"error_code": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
}
},
"nextCursor": {},
"acquired": {
"type": "boolean"
},
"study": {
"type": "object",
"properties": {
"study": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"version": {
"type": "number"
}
},
"additionalProperties": {}
},
"design": {
"type": "object",
"properties": {
"screens": {
"type": "object",
"properties": {
"welcome": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
},
"ending": {
"type": "object",
"properties": {
"title": {
"default": "",
"type": "string",
"maxLength": 4000
},
"body": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
}
}
}
},
"media": {
"type": "object",
"propertyNames": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"additionalProperties": {
"type": "object",
"properties": {
"width": {
"type": "string",
"enum": [
"original",
"full"
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"decorative": {
"default": false,
"type": "boolean"
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"description"
]
}
},
"appearance": {
"type": "object",
"properties": {
"style": {
"default": "default",
"type": "string",
"enum": [
"default",
"relaxed",
"vivid"
]
},
"accent": {
"default": "blue",
"type": "string",
"enum": [
"blue",
"purple",
"green"
]
},
"textSize": {
"default": "default",
"type": "string",
"enum": [
"default",
"large"
]
},
"welcome": {
"default": "",
"type": "string",
"maxLength": 2000
},
"ending": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"purpose": {
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"context": {
"type": "object",
"properties": {
"brief": {
"default": "",
"type": "string",
"maxLength": 4000
},
"decision": {
"default": "",
"type": "string",
"maxLength": 4000
},
"information": {
"default": "",
"type": "string",
"maxLength": 4000
},
"audience": {
"default": "",
"type": "string",
"maxLength": 4000
},
"facts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"assumptions": {
"default": "",
"type": "string",
"maxLength": 4000
},
"excluded": {
"default": "",
"type": "string",
"maxLength": 4000
},
"limitations": {
"default": "",
"type": "string",
"maxLength": 4000
},
"conflicts": {
"default": "",
"type": "string",
"maxLength": 4000
},
"sourceVersion": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sources": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"segment": {
"type": "string",
"maxLength": 200
},
"quote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"assetId",
"segment",
"quote"
]
}
}
}
},
"questions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"type": {
"type": "string",
"enum": [
"single",
"multiple",
"likert5",
"likert7",
"boolean",
"long",
"short",
"grid",
"info"
]
},
"title": {
"type": "string",
"maxLength": 4000
},
"description": {
"default": "",
"type": "string",
"maxLength": 4000
},
"required": {
"default": false,
"type": "boolean"
},
"options": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
},
"exclusive": {
"default": false,
"type": "boolean"
},
"other": {
"default": false,
"type": "boolean"
}
},
"required": [
"id",
"label"
]
}
},
"rows": {
"default": [],
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"label"
]
}
},
"labels": {
"default": [],
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"allowNA": {
"default": false,
"type": "boolean"
},
"shuffle": {
"default": false,
"type": "boolean"
},
"maxSelections": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"maxLength": {
"default": 1000,
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
},
"reverseOf": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"title"
]
}
},
"guide": {
"type": "object",
"properties": {
"interviewer": {
"default": "seoyoon",
"type": "string",
"enum": [
"seoyoon",
"daniel",
"amara",
"elias",
"seorin"
]
},
"topics": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"name": {
"type": "string",
"maxLength": 200
},
"researchQuestion": {
"type": "string",
"maxLength": 4000
},
"priority": {
"type": "string",
"enum": [
"required",
"optional"
]
},
"targets": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"label": {
"type": "string",
"maxLength": 400
}
},
"required": [
"id",
"label"
]
}
},
"coreQuestion": {
"type": "string",
"maxLength": 4000
},
"condition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"probeDirections": {
"type": "string",
"maxLength": 4000
},
"enoughCriteria": {
"type": "string",
"maxLength": 4000
},
"prohibited": {
"type": "string",
"maxLength": 4000
},
"skipCriteria": {
"type": "string",
"maxLength": 4000
},
"surveyQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"assetIds": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"videoLinks": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"description": {
"default": "",
"type": "string",
"maxLength": 1000
},
"transcript": {
"default": "",
"type": "string",
"maxLength": 12000
}
},
"required": [
"url"
]
}
}
},
"required": [
"id",
"name",
"researchQuestion",
"priority",
"targets",
"coreQuestion",
"probeDirections",
"enoughCriteria",
"prohibited",
"skipCriteria",
"surveyQuestionIds"
]
}
},
"targetMinutes": {
"default": 15,
"type": "integer",
"minimum": 3,
"maximum": 120
},
"maxMinutes": {
"default": 18,
"type": "integer",
"minimum": 3,
"maximum": 150
},
"maxProbes": {
"default": 2,
"type": "integer",
"minimum": 0,
"maximum": 4
},
"closingQuestion": {
"default": "이 조사와 관련해 더 덧붙이고 싶은 이야기가 있나요?",
"type": "string",
"maxLength": 1000
}
},
"required": [
"topics"
]
},
"interviewCondition": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"linkedStudy": {
"default": null,
"anyOf": [
{
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"contains_all",
"not_contains",
"answered",
"unanswered",
"gte",
"lte"
]
},
"value": {
"default": null,
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 50,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"questionId",
"operator"
]
}
}
},
"required": [
"mode",
"rules"
]
},
{
"type": "null"
}
]
},
"sharedQuestionIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"purpose": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"studyId",
"condition",
"sharedQuestionIds",
"purpose"
]
},
{
"type": "null"
}
]
}
},
"required": [
"purpose",
"sourceVersion",
"context",
"questions",
"guide"
]
}
},
"additionalProperties": {}
},
"asset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"version": {
"type": "number"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": {}
},
"signedUrl": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/study-ai
service_study_ai_write
Run draft/edit/review/guide against a saved study version. Requires studies:write and confirmCost=true. Poll study read for durable job results; apply the proposal through normal draft save.
Required scopes: studies:write + ai:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"studyId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"feature": {
"type": "string",
"enum": [
"draft",
"edit",
"review",
"guide"
]
},
"instruction": {
"default": "",
"type": "string",
"maxLength": 4000
},
"targetId": {
"default": null,
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"confirmCost": {
"type": "boolean",
"description": "Required true only for an action that invokes a paid provider."
}
},
"required": [
"studyId",
"requestId",
"version",
"feature"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"state": {
"type": "string"
},
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"study_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"input_hash": {
"type": "string"
},
"result": {},
"error_code": {
"type": [
"string",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/images
service_images_read
Read a private profile/team thumbnail. Team images also require workspace:read.
Required scopes: account:read / workspace:read
Parameters
[
{
"name": "scope",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"personal",
"team"
]
}
},
{
"name": "target",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "v",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"hash": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"image/webp": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/images
service_images_write
Replace/remove a profile or authorized team thumbnail with current version. Team images require workspace:write instead.
Required scopes: account:write / workspace:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"personal",
"team"
]
},
"target": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"image": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 400000
},
{
"type": "null"
}
]
}
},
"required": [
"scope",
"target",
"version",
"image"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"hash": {
"type": "string"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/workspace-preference
service_workspace_preference_write
Save the default workspace after checking current membership.
Required scopes: workspace:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"teamId",
"projectId"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"saved": {
"type": "boolean"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/inquiries
service_inquiries_write
Submit a service inquiry from an API/AI client. Screen coordinates are not required.
Required scopes: support:write
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"content": {
"type": "string",
"minLength": 2,
"maxLength": 4000
},
"locale": {
"default": "en",
"type": "string",
"enum": [
"af",
"ar",
"as",
"az",
"bg",
"bn",
"bs",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"fi",
"fil",
"fr",
"gl",
"gu",
"he",
"hi",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"kk",
"kn",
"ko",
"lt",
"lv",
"mk",
"ml",
"mr",
"ms",
"nb",
"ne",
"nl",
"or",
"pa",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"sw",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"yue",
"zh"
]
},
"timeZone": {
"default": "UTC",
"type": "string",
"maxLength": 100
},
"clientContext": {
"type": "object",
"properties": {
"client": {
"type": "string",
"maxLength": 100
},
"version": {
"type": "string",
"maxLength": 100
},
"operationId": {
"type": "string",
"maxLength": 100
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"client"
],
"additionalProperties": false
}
},
"required": [
"requestId",
"content"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/admin
service_admin_read
Read existing service operations and AI support requests. Existing service-admin membership is required; BYOK and security mutations are excluded.
Required scopes: admin:operate
Parameters
[
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "account",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 100
}
},
{
"name": "days",
"in": "query",
"required": false,
"schema": {
"default": 1,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"name": "memberPage",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
{
"name": "feature",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"context",
"draft",
"edit",
"review",
"guide",
"interview",
"guard",
"repair",
"evaluation",
"record_review",
"key_check",
"voice_transcription",
"voice_summary",
"translation"
]
}
},
{
"name": "model",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"microsoft/mai-transcribe-2",
"openai/gpt-6-sol",
"openai/gpt-6-luna",
"openai/gpt-5.6-sol",
"openai/gpt-5.6-terra",
"openai/gpt-5.6-luna"
]
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 10000
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"asOf": {
"type": "string"
},
"teams": {},
"accounts": {},
"counts": {},
"period": {},
"timeline": {
"type": "array",
"items": {}
},
"attempts": {
"type": "array",
"items": {}
},
"audit": {
"type": "array",
"items": {}
},
"budget": {},
"usage": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/admin
service_admin_write
Approve/reject/update existing AI budgets or recover jobs/files. Existing native limits and unknown-cost rules apply.
Required scopes: admin:operate
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"budgetRequestId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"decision": {
"type": "string",
"enum": [
"approve",
"reject",
"update"
]
},
"budget": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"daily_usd": {
"type": "number",
"minimum": 0,
"maximum": 50
},
"monthly_usd": {
"type": "number",
"minimum": 0,
"maximum": 1550
},
"daily_calls": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"starts_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"ends_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"enabled",
"daily_usd",
"monthly_usd",
"daily_calls",
"starts_at",
"ends_at"
]
},
{
"type": "null"
}
]
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 2000
}
},
"required": [
"teamId",
"requestId",
"version",
"budgetRequestId",
"decision",
"budget",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"files",
"cancel_reserved"
]
},
"targetId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 2000
}
},
"required": [
"action",
"targetId",
"requestId",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "reconcile"
},
"attemptId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 2000
}
},
"required": [
"action",
"attemptId",
"requestId",
"reason"
],
"additionalProperties": false
}
]
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"asOf": {
"type": "string"
},
"teams": {},
"accounts": {},
"counts": {},
"period": {},
"timeline": {
"type": "array",
"items": {}
},
"attempts": {
"type": "array",
"items": {}
},
"audit": {
"type": "array",
"items": {}
},
"budget": {},
"usage": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/admin/activity
service_admin_activity_read
Read existing aggregated usage, job activity and safe attempt detail.
Required scopes: admin:operate
Parameters
[
{
"name": "days",
"in": "query",
"required": false,
"schema": {
"default": 1,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"name": "metric",
"in": "query",
"required": false,
"schema": {
"default": "cost",
"type": "string",
"enum": [
"cost",
"calls",
"tokens",
"p95"
]
}
},
{
"name": "group",
"in": "query",
"required": false,
"schema": {
"default": "team",
"type": "string",
"enum": [
"team",
"feature",
"model"
]
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "account",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "feature",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"context",
"draft",
"edit",
"review",
"guide",
"interview",
"guard",
"repair",
"evaluation",
"record_review",
"key_check",
"voice_transcription",
"voice_summary",
"translation"
]
}
},
{
"name": "model",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"microsoft/mai-transcribe-2",
"openai/gpt-6-sol",
"openai/gpt-6-luna",
"openai/gpt-5.6-sol",
"openai/gpt-5.6-terra",
"openai/gpt-5.6-luna"
]
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"default": "all",
"type": "string",
"enum": [
"all",
"settled",
"reserved",
"running",
"unknown",
"cancelled"
]
}
},
{
"name": "slot",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
{
"name": "attempt",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 10000
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"asOf": {
"type": "string"
},
"rows": {
"type": "array",
"items": {}
},
"totals": {}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/admin/support
service_admin_support_read
Read existing service support policies and balances.
Required scopes: admin:operate
Parameters
[
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"default": "",
"type": "string",
"maxLength": 100
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"policy": {},
"awarded": {
"type": "number"
},
"allocated": {
"type": "number"
},
"creditUsage": {},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"rows": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/admin/support
service_admin_support_write
Update current support policy, grant/reduce support or reject a request. No provider or payment call is made.
Required scopes: admin:operate
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"policy",
"grant",
"reduce",
"reject"
]
},
"input": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "policy"
},
"enabled": {
"type": "boolean"
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000,
"multipleOf": 0.01
},
"maxUsers": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"includeExisting": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 2000
}
},
"required": [
"kind",
"enabled",
"amount",
"maxUsers",
"includeExisting",
"version",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "grant"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"accountId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"budgetRequestId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000,
"multipleOf": 0.01
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 2000
}
},
"required": [
"kind",
"teamId",
"accountId",
"budgetRequestId",
"amount",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "reduce"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"accountId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"budgetRequestId": {
"type": "null"
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000,
"multipleOf": 0.01
},
"expectedGranted": {
"type": "number",
"minimum": 0
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 2000
}
},
"required": [
"kind",
"teamId",
"accountId",
"budgetRequestId",
"amount",
"expectedGranted",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "reject"
},
"teamId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"accountId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"budgetRequestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 2000
}
},
"required": [
"kind",
"teamId",
"accountId",
"budgetRequestId",
"reason"
],
"additionalProperties": false
}
]
}
},
"required": [
"requestId",
"action",
"input"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"policy": {},
"awarded": {
"type": "number"
},
"allocated": {
"type": "number"
},
"creditUsage": {},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"rows": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/admin/inquiries
service_admin_inquiries_read
Read paginated service inquiries.
Required scopes: admin:operate
Parameters
[
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
}
}
]Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"rows": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/admin/inquiries
service_admin_inquiries_write
Update an existing service inquiry status.
Required scopes: admin:operate
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"status": {
"type": "string",
"enum": [
"new",
"resolved"
]
}
},
"required": [
"id",
"status"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"rows": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}GET/service/admin/external
service_admin_external_read
Read manually recorded external usage estimates. These records are not observed provider billing.
Required scopes: admin:operate
Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"entries": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}POST/service/admin/external
service_admin_external_write
Save/delete a manually recorded external usage estimate with version and requestId. No key configuration or purchase is performed.
Required scopes: admin:operate
Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"enum": [
"save",
"delete"
]
},
"entry": {
"anyOf": [
{
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000,
"multipleOf": 0.01
},
"from": {
"type": "string",
"minLength": 10,
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"to": {
"type": "string",
"minLength": 10,
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"funding": {
"type": "string",
"enum": [
"credits",
"byok"
]
},
"models": {
"minItems": 5,
"maxItems": 5,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"bytedance/seedance-2.0",
"openai/gpt-6-sol",
"openai/gpt-5.6-sol",
"openai/gpt-6-luna",
"microsoft/mai-transcribe-2"
]
},
"weight": {
"type": "number",
"minimum": 0,
"maximum": 1000000
},
"inputRate": {
"type": "number",
"minimum": 0,
"maximum": 10000
},
"outputRate": {
"type": "number",
"minimum": 0,
"maximum": 10000
},
"inputPerRequest": {
"type": "integer",
"minimum": 0,
"maximum": 10000000
},
"outputPerRequest": {
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"required": [
"id",
"weight",
"inputRate",
"outputRate",
"inputPerRequest",
"outputPerRequest"
],
"additionalProperties": false
}
}
},
"required": [
"label",
"amount",
"from",
"to",
"funding",
"models"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"requestId",
"id",
"version",
"action",
"entry"
],
"additionalProperties": false
}
}
}
}Responses
{
"200": {
"description": "Current authorized service result. Action-specific fields are optional; additional native result fields are returned. Native versions, visibility, consent and recovery rules apply.",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"actorId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"entries": {
"type": "array",
"items": {}
}
},
"additionalProperties": {}
}
}
}
},
"default": {
"description": "RFC 9457 problem details with code, status and requestId."
}
}Changes, publishing, and duplicate requests
Saving a draft never publishes it. New studies use a caller-generated UUID and version=0; updates require the current version. Preserve requestId and the exact body after a lost response. Changed input with the same identifier returns 409.
Before publication or collection/share changes, request the matching preview and review its effects. Commit the returned review hash with explicit confirmation. File deletion also requires review.
A 202 interview response means work was accepted; poll the returned operation. Disconnection is not cancellation. AI work uses existing service quotas.
Errors and rate limits
Errors use application/problem+json with code, status and requestId. Keep requestId when reporting a failure.
401- Invalid, expired or revoked credential
403- Insufficient scope, role or data access
404- Resource absent or not accessible
409- Version conflict, current consent or review required
422- Invalid input
429- Rate limit: wait for Retry-After before retrying
503- Temporarily unavailable; retry with the same identifier
Exports stop with EXPORT_TOO_LARGE above 5,000 responses or 50,000 turns; data is never silently truncated.