メインコンテンツへスキップ
POST
cURL
このエンドポイントを使用すると、API経由でシンプルなアンケートを作成できます。ユーザーに回答してほしい順序で質問を並べたform_elements配列を送信してください。内部のアンケートグラフはDiditが自動で構築します。 APIがサポートするのは、分岐のないシンプルなアンケートのみです。graph、branches、next、または条件付きルールは送信しないでください。

必須フィールド

  • titleはアンケートの内部名です。
  • languagesにはenを含める必要があります。
  • form_elementsには少なくとも1つの質問を含める必要があります。
  • 各フォーム要素にはelement_typeと翻訳済みのlabelが必要です。
フォーム要素には、ヘルプテキストとして任意で翻訳済みのdescriptionを追加することもできます。これはseparatorを除くすべての要素タイプで受け付けられ、アンケートレポートでは項目のdescriptionとして返されます。

要素タイプ

short_text、multiple_choice、email、file_upload、date_pickerなどの小文字の値を使用してください。SHORT_TEXTのような大文字のenum値も受け付けられます。 dropdown、single_choice、multiple_choiceにはoptionsを追加してください。選択肢のvalueを省略した場合は、Diditがラベルから値を生成します。

フィールドの検証

short_text、long_text、numberの要素には、任意でvalidationオブジェクトを追加して、ユーザーの回答の形式を制限できます。これは、納税者番号、国民ID、カード番号など、形式が厳格に決まっている識別子に便利です。検証はユーザーがフィールドに入力している間に実行されます(検証に通るまでユーザーは先に進めません)。また、送信時にはAPIによって再度検証されます。
レスポンスにはquestionnaire_idが含まれます。アンケートをワークフローに追加する際にquestionnaire_uuidとして使用するため、この値を保存してください。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

ボディ

application/json

シンプルな直線型アンケートを作成します。APIはform_elementsを内部のアンケートグラフに変換します。

title
string
必須

アンケートの内部名。

languages
string[]
必須

すべてのラベルに含まれる言語。enを含める必要があります。

例:
form_elements
object[]
必須

ユーザーに表示する正確な順序で並べた質問。分岐や条件付きフィールドはサポートされていません。

Minimum array length: 1
description
string | null
default_language
string

デフォルト言語。languagesに含まれている必要があります。

例:

"en"

is_active
boolean
デフォルト:true
status
enum<string>

このフィールドを省略すると、ワークフローですぐに使える公開済みのアンケートが作成されます。

利用可能なオプション:
draft,
published

レスポンス

アンケートが作成されました。レスポンスにはquestionnaire_idが含まれます。ワークフローや今後の更新・削除の呼び出しからこのアンケートを参照できるよう、保存してください。

GET、POST(作成)、PATCH(更新)の各エンドポイントから返されるアンケートの完全な詳細。

questionnaire_id
string<uuid>

アンケートの一意の識別子。ワークフローからアンケートを参照する場合や、以降の更新・削除リクエストでこのIDを使用します。

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

start_nodeとnodesマップを含むグラフ構造。

sections
object[]

セクションごとにまとめられたアンケートの内容(グラフから導出)。

questionnaire_group_id
string<uuid>

同じアンケートのすべてのバージョンをまとめる不変の識別子。

version
integer
status
enum<string>
利用可能なオプション:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

アンケートをその場で編集できる場合(ドラフトバージョン)はtrue。

最終更新日 2026年11月1日