メインコンテンツへスキップ
GET
cURL

承認

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

パスパラメータ

questionnaire_uuid
string<uuid>
必須

アンケートのバージョンごとのUUIDです(一覧エンドポイントが返すuuidの値で、詳細エンドポイントではquestionnaire_idとしても返されます)。

レスポンス

正規のgraph、派生したsectionsビュー、バージョンのメタデータ、is_editableを含むアンケートの完全な詳細。

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日