フォーム
DECAフォームAPIと統合します
トリガー
このノードでフローを開始できるイベントです。トリガーを選択 から追加します。
回答作成
特定のフォームで回答が作成されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば form.id は $trigger.output.form.id です。
json
{
"form": {
"id": "string",
"name": "string"
},
"createdBy": {
"ip": "string",
"userAgent": "string",
"profile": {}
},
"answers": [
{
"question": {
"id": "string",
"label": "string",
"type": "string"
},
"page": {
"id": "string",
"name": {}
},
"response": {
"id": "string",
"answers": [],
"flatAnswer": "string",
"normalizedAnswer": "string"
}
}
],
"createdAt": "2026-01-01T09:00:00Z",
"nonInputQuestions": [
"string"
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
form | オブジェクト | フォーム情報 |
form.id | テキスト | フォームの一意の識別子 |
form.name | テキスト | フォーム名 |
createdBy | オブジェクト | この回答の作成者に関する情報 |
createdBy.ip | テキスト | 回答者のIPアドレス |
createdBy.userAgent | テキスト | 回答者のブラウザのユーザーエージェント |
createdBy.profile | オブジェクト | 提供されている場合のユーザープロフィール |
answers[] | リスト | 質問に対する回答のリスト |
answers[].question | オブジェクト | |
answers[].question.id | テキスト | |
answers[].question.label | テキスト | |
answers[].question.type | テキスト | |
answers[].page | オブジェクト | |
answers[].page.id | テキスト | |
answers[].page.name | オブジェクト | |
answers[].page.name.name | テキスト | |
answers[].page.name.is_visible | はい / いいえ | |
answers[].response | オブジェクト | |
answers[].response.id | テキスト | |
answers[].response.answers[] | リスト | |
answers[].response.answers[].value | テキスト | |
answers[].response.answers[].is_other | はい / いいえ | |
answers[].response.answers[].asset | オブジェクト | |
answers[].response.flatAnswer | テキスト | |
answers[].response.normalizedAnswer | テキスト | |
createdAt | テキスト | 回答作成時のタイムスタンプ |
nonInputQuestions[] | リスト | フォーム内の入力以外の質問の一覧。要素は自由形式の質問オブジェクトです |
フォーム作成
フォームが作成されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば id は $trigger.output.id です。
json
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | フォームの一意の識別子 |
name | テキスト | フォーム名 |
start_at | テキスト | フォームの開始時間 |
expired_at | テキスト | フォームの期限切れ時間 |
appearance | オブジェクト | フォーム外観設定 |
appearance.header_style | オブジェクト | ヘッダー外観設定 |
appearance.header_style.logo_align | テキスト | ロゴの配置位置 |
appearance.header_style.logo_size | テキスト | ロゴのサイズ |
appearance.header_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.header_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.header_style.text | テキスト | ヘッダーテキストコンテンツ |
appearance.header_style.position | テキスト | ヘッダー位置 |
appearance.footer_style | オブジェクト | フッター外観設定 |
appearance.footer_style.logo_align | テキスト | ロゴの配置位置 |
appearance.footer_style.logo_size | テキスト | ロゴのサイズ |
appearance.footer_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.footer_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.footer_style.text | テキスト | フッターテキストコンテンツ |
appearance.form_field_style | オブジェクト | フォームフィールド外観設定 |
appearance.form_field_style.color | オブジェクト | フォームフィールドの色設定 |
appearance.form_field_style.color.question | テキスト | 質問テキスト色 |
appearance.form_field_style.color.answer | テキスト | 回答テキスト色 |
appearance.form_field_style.color.icon | テキスト | アイコン色 |
appearance.form_field_style.color.description | テキスト | 説明テキスト色 |
appearance.form_field_style.color.placeholder | テキスト | プレースホルダーテキスト色 |
appearance.form_field_style.color.field_stroke | テキスト | フィールド境界線色 |
appearance.form_field_style.color.field_background | テキスト | フィールド背景色 |
appearance.form_field_style.font_family | オブジェクト | フォームフィールドのフォントファミリー設定 |
appearance.form_field_style.font_family.question | テキスト | 質問フォントファミリー |
appearance.form_field_style.font_family.answer | テキスト | 回答フォントファミリー |
appearance.form_field_style.font_family.text | テキスト | テキストフォントファミリー |
appearance.form_field_style.font_size | オブジェクト | フォームフィールドのフォントサイズ設定 |
appearance.form_field_style.font_size.question | 数値 | 質問フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.answer | 数値 | 回答フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.text | 数値 | テキストフォントサイズ（ピクセル） |
appearance.button_style | オブジェクト | ボタン外観設定 |
appearance.button_style.type | テキスト | ボタンタイプ |
appearance.button_style.full_width | はい / いいえ | ボタンが全幅を取るかどうか |
appearance.button_style.background_color | テキスト | ボタンの背景色 |
appearance.button_style.text_color | テキスト | ボタンのテキスト色 |
appearance.button_style.font_family | テキスト | ボタンのフォントファミリー |
appearance.button_style.font_size | 数値 | ボタンのフォントサイズ（ピクセル） |
appearance.heading_style | オブジェクト | 見出し外観設定 |
appearance.heading_style.font_family | テキスト | 見出しフォントファミリー |
appearance.heading_style.font_size | 数値 | 見出しフォントサイズ（ピクセル） |
appearance.heading_style.color | テキスト | 見出しテキスト色 |
appearance.paragraph_style | オブジェクト | 段落外観設定 |
appearance.paragraph_style.font_family | テキスト | 段落フォントファミリー |
appearance.paragraph_style.font_size | 数値 | 段落フォントサイズ（ピクセル） |
appearance.paragraph_style.color | テキスト | 段落テキスト色 |
appearance.customize | はい / いいえ | 外観がカスタマイズされているかどうか |
appearance.default_settings | オブジェクト | デフォルト外観設定 |
appearance.default_settings.color | テキスト | デフォルト色 |
appearance.default_settings.font_family | テキスト | デフォルトフォントファミリー |
appearance.default_settings.input_style | テキスト | デフォルト入力フィールドスタイル |
metadata | オブジェクト | フォームメタデータ |
metadata.organization_id | テキスト | 組織の一意の識別子 |
metadata.workspace_id | テキスト | ワークスペースの一意の識別子 |
metadata.org_name | テキスト | 組織名 |
is_template | はい / いいえ | フォームがテンプレートかどうか |
screenshot | オブジェクト | フォームサムネイル |
screenshot.original | テキスト | 元のスクリーンショット画像のURL |
screenshot.thumbnail | テキスト | スクリーンショットのサムネイル版のURL |
screenshot.preview | テキスト | スクリーンショットのプレビュー版のURL |
responses | 数値 | 回答数 |
status | テキスト | フォームステータス |
setting | オブジェクト | フォーム設定 |
アクション
このノードが実行できる処理です。ステップを追加 からノードを追加し、アクションを選びます。
フォーム一覧
オプションのフィルタリングとページネーションでフォームを一覧表示します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| お気に入り | はい / いいえ | お気に入りフォームを選択 既定値: false | |
| テンプレートソース | 選択 | is_templateがtrueのときにテンプレートソースを選択 選択肢: 一般, ワークスペース既定値: general | |
| 検索 | テキスト | フォームをフィルタリングする検索語 | |
| フィルター | テキスト | JSONオブジェクトでフィルタリング | |
| ソート | テキスト | 昇順はfield_name、降順は-field_nameでソート。複数の値は「,」区切りでサポート | |
| ページ | 数値 | 一覧表示の選択されたページ 既定値: 1 | |
| ページあたり | 数値 | 1ページあたりのアイテム数 既定値: 10 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば responses[0].id は $.<ステップID>.output.responses[0].id です。
json
{
"responses": [
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}
],
"pagination": {
"total_item": 0,
"total_page": 0,
"per_page": 0,
"current_page": 0
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
responses[] | リスト | フォーム一覧 |
responses[].id | テキスト | フォームの一意の識別子 |
responses[].name | テキスト | フォーム名 |
responses[].start_at | テキスト | フォームの開始時間 |
responses[].expired_at | テキスト | フォームの期限切れ時間 |
responses[].appearance | オブジェクト | フォーム外観設定 |
responses[].appearance.header_style | オブジェクト | ヘッダー外観設定 |
responses[].appearance.header_style.logo_align | テキスト | ロゴの配置位置 |
responses[].appearance.header_style.logo_size | テキスト | ロゴのサイズ |
responses[].appearance.header_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
responses[].appearance.header_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
responses[].appearance.header_style.text | テキスト | ヘッダーテキストコンテンツ |
responses[].appearance.header_style.position | テキスト | ヘッダー位置 |
responses[].appearance.footer_style | オブジェクト | フッター外観設定 |
responses[].appearance.footer_style.logo_align | テキスト | ロゴの配置位置 |
responses[].appearance.footer_style.logo_size | テキスト | ロゴのサイズ |
responses[].appearance.footer_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
responses[].appearance.footer_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
responses[].appearance.footer_style.text | テキスト | フッターテキストコンテンツ |
responses[].appearance.form_field_style | オブジェクト | フォームフィールド外観設定 |
responses[].appearance.form_field_style.color | オブジェクト | フォームフィールドの色設定 |
responses[].appearance.form_field_style.font_family | オブジェクト | フォームフィールドのフォントファミリー設定 |
responses[].appearance.form_field_style.font_size | オブジェクト | フォームフィールドのフォントサイズ設定 |
responses[].appearance.button_style | オブジェクト | ボタン外観設定 |
responses[].appearance.button_style.type | テキスト | ボタンタイプ |
responses[].appearance.button_style.full_width | はい / いいえ | ボタンが全幅を取るかどうか |
responses[].appearance.button_style.background_color | テキスト | ボタンの背景色 |
responses[].appearance.button_style.text_color | テキスト | ボタンのテキスト色 |
responses[].appearance.button_style.font_family | テキスト | ボタンのフォントファミリー |
responses[].appearance.button_style.font_size | 数値 | ボタンのフォントサイズ（ピクセル） |
responses[].appearance.heading_style | オブジェクト | 見出し外観設定 |
responses[].appearance.heading_style.font_family | テキスト | 見出しフォントファミリー |
responses[].appearance.heading_style.font_size | 数値 | 見出しフォントサイズ（ピクセル） |
responses[].appearance.heading_style.color | テキスト | 見出しテキスト色 |
responses[].appearance.paragraph_style | オブジェクト | 段落外観設定 |
responses[].appearance.paragraph_style.font_family | テキスト | 段落フォントファミリー |
responses[].appearance.paragraph_style.font_size | 数値 | 段落フォントサイズ（ピクセル） |
responses[].appearance.paragraph_style.color | テキスト | 段落テキスト色 |
responses[].appearance.customize | はい / いいえ | 外観がカスタマイズされているかどうか |
responses[].appearance.default_settings | オブジェクト | デフォルト外観設定 |
responses[].appearance.default_settings.color | テキスト | デフォルト色 |
responses[].appearance.default_settings.font_family | テキスト | デフォルトフォントファミリー |
responses[].appearance.default_settings.input_style | テキスト | デフォルト入力フィールドスタイル |
responses[].metadata | オブジェクト | フォームメタデータ |
responses[].metadata.organization_id | テキスト | 組織の一意の識別子 |
responses[].metadata.workspace_id | テキスト | ワークスペースの一意の識別子 |
responses[].metadata.org_name | テキスト | 組織名 |
responses[].is_template | はい / いいえ | フォームがテンプレートかどうか |
responses[].screenshot | オブジェクト | フォームサムネイル |
responses[].screenshot.original | テキスト | 元のスクリーンショット画像のURL |
responses[].screenshot.thumbnail | テキスト | スクリーンショットのサムネイル版のURL |
responses[].screenshot.preview | テキスト | スクリーンショットのプレビュー版のURL |
responses[].responses | 数値 | 回答数 |
responses[].status | テキスト | フォームステータス |
responses[].setting | オブジェクト | フォーム設定 |
pagination | オブジェクト | ページネーション情報 |
pagination.total_item | 数値 | 総項目数 |
pagination.total_page | 数値 | 総ページ数 |
pagination.per_page | 数値 | 1ページあたりの項目数 |
pagination.current_page | 数値 | 現在のページ番号 |
フォーム取得
フォームIDまたはフォームスラッグでフォーム詳細を取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 取得するフォームIDまたはフォームスラッグ |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | フォームの一意の識別子 |
name | テキスト | フォーム名 |
start_at | テキスト | フォームの開始時間 |
expired_at | テキスト | フォームの期限切れ時間 |
appearance | オブジェクト | フォーム外観設定 |
appearance.header_style | オブジェクト | ヘッダー外観設定 |
appearance.header_style.logo_align | テキスト | ロゴの配置位置 |
appearance.header_style.logo_size | テキスト | ロゴのサイズ |
appearance.header_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.header_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.header_style.text | テキスト | ヘッダーテキストコンテンツ |
appearance.header_style.position | テキスト | ヘッダー位置 |
appearance.footer_style | オブジェクト | フッター外観設定 |
appearance.footer_style.logo_align | テキスト | ロゴの配置位置 |
appearance.footer_style.logo_size | テキスト | ロゴのサイズ |
appearance.footer_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.footer_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.footer_style.text | テキスト | フッターテキストコンテンツ |
appearance.form_field_style | オブジェクト | フォームフィールド外観設定 |
appearance.form_field_style.color | オブジェクト | フォームフィールドの色設定 |
appearance.form_field_style.color.question | テキスト | 質問テキスト色 |
appearance.form_field_style.color.answer | テキスト | 回答テキスト色 |
appearance.form_field_style.color.icon | テキスト | アイコン色 |
appearance.form_field_style.color.description | テキスト | 説明テキスト色 |
appearance.form_field_style.color.placeholder | テキスト | プレースホルダーテキスト色 |
appearance.form_field_style.color.field_stroke | テキスト | フィールド境界線色 |
appearance.form_field_style.color.field_background | テキスト | フィールド背景色 |
appearance.form_field_style.font_family | オブジェクト | フォームフィールドのフォントファミリー設定 |
appearance.form_field_style.font_family.question | テキスト | 質問フォントファミリー |
appearance.form_field_style.font_family.answer | テキスト | 回答フォントファミリー |
appearance.form_field_style.font_family.text | テキスト | テキストフォントファミリー |
appearance.form_field_style.font_size | オブジェクト | フォームフィールドのフォントサイズ設定 |
appearance.form_field_style.font_size.question | 数値 | 質問フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.answer | 数値 | 回答フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.text | 数値 | テキストフォントサイズ（ピクセル） |
appearance.button_style | オブジェクト | ボタン外観設定 |
appearance.button_style.type | テキスト | ボタンタイプ |
appearance.button_style.full_width | はい / いいえ | ボタンが全幅を取るかどうか |
appearance.button_style.background_color | テキスト | ボタンの背景色 |
appearance.button_style.text_color | テキスト | ボタンのテキスト色 |
appearance.button_style.font_family | テキスト | ボタンのフォントファミリー |
appearance.button_style.font_size | 数値 | ボタンのフォントサイズ（ピクセル） |
appearance.heading_style | オブジェクト | 見出し外観設定 |
appearance.heading_style.font_family | テキスト | 見出しフォントファミリー |
appearance.heading_style.font_size | 数値 | 見出しフォントサイズ（ピクセル） |
appearance.heading_style.color | テキスト | 見出しテキスト色 |
appearance.paragraph_style | オブジェクト | 段落外観設定 |
appearance.paragraph_style.font_family | テキスト | 段落フォントファミリー |
appearance.paragraph_style.font_size | 数値 | 段落フォントサイズ（ピクセル） |
appearance.paragraph_style.color | テキスト | 段落テキスト色 |
appearance.customize | はい / いいえ | 外観がカスタマイズされているかどうか |
appearance.default_settings | オブジェクト | デフォルト外観設定 |
appearance.default_settings.color | テキスト | デフォルト色 |
appearance.default_settings.font_family | テキスト | デフォルトフォントファミリー |
appearance.default_settings.input_style | テキスト | デフォルト入力フィールドスタイル |
metadata | オブジェクト | フォームメタデータ |
metadata.organization_id | テキスト | 組織の一意の識別子 |
metadata.workspace_id | テキスト | ワークスペースの一意の識別子 |
metadata.org_name | テキスト | 組織名 |
is_template | はい / いいえ | フォームがテンプレートかどうか |
screenshot | オブジェクト | フォームサムネイル |
screenshot.original | テキスト | 元のスクリーンショット画像のURL |
screenshot.thumbnail | テキスト | スクリーンショットのサムネイル版のURL |
screenshot.preview | テキスト | スクリーンショットのプレビュー版のURL |
responses | 数値 | 回答数 |
status | テキスト | フォームステータス |
setting | オブジェクト | フォーム設定 |
フォーム作成
新しいフォームを作成します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 名前 | テキスト | はい | フォーム名 |
| タグ | リスト | フォームタグ | |
| 開始日時 | 日時 | フォーム開始日時 | |
| 終了日時 | 日時 | フォーム終了日時 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | フォームの一意の識別子 |
name | テキスト | フォーム名 |
start_at | テキスト | フォームの開始時間 |
expired_at | テキスト | フォームの期限切れ時間 |
appearance | オブジェクト | フォーム外観設定 |
appearance.header_style | オブジェクト | ヘッダー外観設定 |
appearance.header_style.logo_align | テキスト | ロゴの配置位置 |
appearance.header_style.logo_size | テキスト | ロゴのサイズ |
appearance.header_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.header_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.header_style.text | テキスト | ヘッダーテキストコンテンツ |
appearance.header_style.position | テキスト | ヘッダー位置 |
appearance.footer_style | オブジェクト | フッター外観設定 |
appearance.footer_style.logo_align | テキスト | ロゴの配置位置 |
appearance.footer_style.logo_size | テキスト | ロゴのサイズ |
appearance.footer_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.footer_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.footer_style.text | テキスト | フッターテキストコンテンツ |
appearance.form_field_style | オブジェクト | フォームフィールド外観設定 |
appearance.form_field_style.color | オブジェクト | フォームフィールドの色設定 |
appearance.form_field_style.color.question | テキスト | 質問テキスト色 |
appearance.form_field_style.color.answer | テキスト | 回答テキスト色 |
appearance.form_field_style.color.icon | テキスト | アイコン色 |
appearance.form_field_style.color.description | テキスト | 説明テキスト色 |
appearance.form_field_style.color.placeholder | テキスト | プレースホルダーテキスト色 |
appearance.form_field_style.color.field_stroke | テキスト | フィールド境界線色 |
appearance.form_field_style.color.field_background | テキスト | フィールド背景色 |
appearance.form_field_style.font_family | オブジェクト | フォームフィールドのフォントファミリー設定 |
appearance.form_field_style.font_family.question | テキスト | 質問フォントファミリー |
appearance.form_field_style.font_family.answer | テキスト | 回答フォントファミリー |
appearance.form_field_style.font_family.text | テキスト | テキストフォントファミリー |
appearance.form_field_style.font_size | オブジェクト | フォームフィールドのフォントサイズ設定 |
appearance.form_field_style.font_size.question | 数値 | 質問フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.answer | 数値 | 回答フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.text | 数値 | テキストフォントサイズ（ピクセル） |
appearance.button_style | オブジェクト | ボタン外観設定 |
appearance.button_style.type | テキスト | ボタンタイプ |
appearance.button_style.full_width | はい / いいえ | ボタンが全幅を取るかどうか |
appearance.button_style.background_color | テキスト | ボタンの背景色 |
appearance.button_style.text_color | テキスト | ボタンのテキスト色 |
appearance.button_style.font_family | テキスト | ボタンのフォントファミリー |
appearance.button_style.font_size | 数値 | ボタンのフォントサイズ（ピクセル） |
appearance.heading_style | オブジェクト | 見出し外観設定 |
appearance.heading_style.font_family | テキスト | 見出しフォントファミリー |
appearance.heading_style.font_size | 数値 | 見出しフォントサイズ（ピクセル） |
appearance.heading_style.color | テキスト | 見出しテキスト色 |
appearance.paragraph_style | オブジェクト | 段落外観設定 |
appearance.paragraph_style.font_family | テキスト | 段落フォントファミリー |
appearance.paragraph_style.font_size | 数値 | 段落フォントサイズ（ピクセル） |
appearance.paragraph_style.color | テキスト | 段落テキスト色 |
appearance.customize | はい / いいえ | 外観がカスタマイズされているかどうか |
appearance.default_settings | オブジェクト | デフォルト外観設定 |
appearance.default_settings.color | テキスト | デフォルト色 |
appearance.default_settings.font_family | テキスト | デフォルトフォントファミリー |
appearance.default_settings.input_style | テキスト | デフォルト入力フィールドスタイル |
metadata | オブジェクト | フォームメタデータ |
metadata.organization_id | テキスト | 組織の一意の識別子 |
metadata.workspace_id | テキスト | ワークスペースの一意の識別子 |
metadata.org_name | テキスト | 組織名 |
is_template | はい / いいえ | フォームがテンプレートかどうか |
screenshot | オブジェクト | フォームサムネイル |
screenshot.original | テキスト | 元のスクリーンショット画像のURL |
screenshot.thumbnail | テキスト | スクリーンショットのサムネイル版のURL |
screenshot.preview | テキスト | スクリーンショットのプレビュー版のURL |
responses | 数値 | 回答数 |
status | テキスト | フォームステータス |
setting | オブジェクト | フォーム設定 |
フォーム更新
既存のフォームを更新します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 更新するフォームID |
| 名前 | テキスト | フォーム名 | |
| タグ | リスト | フォームタグ | |
| 開始日時 | 日時 | フォーム開始日時 | |
| 終了日時 | 日時 | フォーム終了日時 | |
| ステータス | 選択 | フォームステータス 選択肢: 下書き, アクティブ, クローズ既定値: draft | |
| ピン留め | はい / いいえ | フォームがピン留めされているか |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | フォームの一意の識別子 |
name | テキスト | フォーム名 |
start_at | テキスト | フォームの開始時間 |
expired_at | テキスト | フォームの期限切れ時間 |
appearance | オブジェクト | フォーム外観設定 |
appearance.header_style | オブジェクト | ヘッダー外観設定 |
appearance.header_style.logo_align | テキスト | ロゴの配置位置 |
appearance.header_style.logo_size | テキスト | ロゴのサイズ |
appearance.header_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.header_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.header_style.text | テキスト | ヘッダーテキストコンテンツ |
appearance.header_style.position | テキスト | ヘッダー位置 |
appearance.footer_style | オブジェクト | フッター外観設定 |
appearance.footer_style.logo_align | テキスト | ロゴの配置位置 |
appearance.footer_style.logo_size | テキスト | ロゴのサイズ |
appearance.footer_style.logo_image | テキスト | ロゴ画像のURLまたはパス |
appearance.footer_style.is_using_text | はい / いいえ | ロゴの代わりにテキストを使用するかどうか |
appearance.footer_style.text | テキスト | フッターテキストコンテンツ |
appearance.form_field_style | オブジェクト | フォームフィールド外観設定 |
appearance.form_field_style.color | オブジェクト | フォームフィールドの色設定 |
appearance.form_field_style.color.question | テキスト | 質問テキスト色 |
appearance.form_field_style.color.answer | テキスト | 回答テキスト色 |
appearance.form_field_style.color.icon | テキスト | アイコン色 |
appearance.form_field_style.color.description | テキスト | 説明テキスト色 |
appearance.form_field_style.color.placeholder | テキスト | プレースホルダーテキスト色 |
appearance.form_field_style.color.field_stroke | テキスト | フィールド境界線色 |
appearance.form_field_style.color.field_background | テキスト | フィールド背景色 |
appearance.form_field_style.font_family | オブジェクト | フォームフィールドのフォントファミリー設定 |
appearance.form_field_style.font_family.question | テキスト | 質問フォントファミリー |
appearance.form_field_style.font_family.answer | テキスト | 回答フォントファミリー |
appearance.form_field_style.font_family.text | テキスト | テキストフォントファミリー |
appearance.form_field_style.font_size | オブジェクト | フォームフィールドのフォントサイズ設定 |
appearance.form_field_style.font_size.question | 数値 | 質問フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.answer | 数値 | 回答フォントサイズ（ピクセル） |
appearance.form_field_style.font_size.text | 数値 | テキストフォントサイズ（ピクセル） |
appearance.button_style | オブジェクト | ボタン外観設定 |
appearance.button_style.type | テキスト | ボタンタイプ |
appearance.button_style.full_width | はい / いいえ | ボタンが全幅を取るかどうか |
appearance.button_style.background_color | テキスト | ボタンの背景色 |
appearance.button_style.text_color | テキスト | ボタンのテキスト色 |
appearance.button_style.font_family | テキスト | ボタンのフォントファミリー |
appearance.button_style.font_size | 数値 | ボタンのフォントサイズ（ピクセル） |
appearance.heading_style | オブジェクト | 見出し外観設定 |
appearance.heading_style.font_family | テキスト | 見出しフォントファミリー |
appearance.heading_style.font_size | 数値 | 見出しフォントサイズ（ピクセル） |
appearance.heading_style.color | テキスト | 見出しテキスト色 |
appearance.paragraph_style | オブジェクト | 段落外観設定 |
appearance.paragraph_style.font_family | テキスト | 段落フォントファミリー |
appearance.paragraph_style.font_size | 数値 | 段落フォントサイズ（ピクセル） |
appearance.paragraph_style.color | テキスト | 段落テキスト色 |
appearance.customize | はい / いいえ | 外観がカスタマイズされているかどうか |
appearance.default_settings | オブジェクト | デフォルト外観設定 |
appearance.default_settings.color | テキスト | デフォルト色 |
appearance.default_settings.font_family | テキスト | デフォルトフォントファミリー |
appearance.default_settings.input_style | テキスト | デフォルト入力フィールドスタイル |
metadata | オブジェクト | フォームメタデータ |
metadata.organization_id | テキスト | 組織の一意の識別子 |
metadata.workspace_id | テキスト | ワークスペースの一意の識別子 |
metadata.org_name | テキスト | 組織名 |
is_template | はい / いいえ | フォームがテンプレートかどうか |
screenshot | オブジェクト | フォームサムネイル |
screenshot.original | テキスト | 元のスクリーンショット画像のURL |
screenshot.thumbnail | テキスト | スクリーンショットのサムネイル版のURL |
screenshot.preview | テキスト | スクリーンショットのプレビュー版のURL |
responses | 数値 | 回答数 |
status | テキスト | フォームステータス |
setting | オブジェクト | フォーム設定 |
フォーム削除
フォームを削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 削除するフォームID |
出力
出力フィールドの定義はありません。
フォーム複製
特定のワークスペース用にフォームを複製します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 複製するフォームID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"external_id": "string",
"fn": "string",
"status": "string",
"delay": 0,
"result": {},
"created_at": "2026-01-01T09:00:00Z",
"updated_at": "2026-01-01T09:00:00Z",
"started_at": "2026-01-01T09:00:00Z",
"finished_at": "2026-01-01T09:00:00Z"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | タスクID、これは内部IDです |
external_id | テキスト | タスクID、これは外部IDです |
fn | テキスト | タスク関数 |
status | テキスト | タスクステータス |
delay | 数値 | タスク遅延 |
result | オブジェクト | タスク結果 |
created_at | テキスト | タスク作成タイムスタンプ |
updated_at | テキスト | タスク最終更新タイムスタンプ |
started_at | テキスト | タスク開始タイムスタンプ |
finished_at | テキスト | タスク完了タイムスタンプ |
すべてのフォームページ一覧
オプションのフィルタリングとページネーションでフォームを一覧表示します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | すべてのページを一覧表示するフォームID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
json
[
{
"id": "string",
"name": "string",
"layout": {
"type": "image-top-with-space",
"image_url": "string",
"field_width": "string",
"show_progress_bar": false
},
"type": "section",
"index": 0,
"created_at": "2026-01-01T09:00:00Z",
"updated_at": "2026-01-01T09:00:00Z",
"content": [
{
"id": "string",
"index": 0,
"type": "short_qa",
"label": "string",
"name": "string",
"is_other": false,
"is_hide": false,
"time_format": "string",
"date_format": "string",
"dob_enabled": false,
"input_directly_enabled": false,
"fixed_date_title_enabled": false,
"description": "string",
"icon": "string",
"right_icon": false,
"supported_types": [],
"theme": "small",
"footer_hide": false,
"max_scale": 0,
"show_number": true,
"footer_label": {},
"shape": "star",
"description_enabled": false,
"hide_label": false,
"placeholder": "string",
"validators": [],
"style": {},
"layout": "one_column",
"options": [],
"fields": []
}
]
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ページID |
name | テキスト | ページ名 |
layout | オブジェクト | ページレイアウト設定 |
layout.type | 選択 | レイアウトタイプ |
layout.image_url | テキスト | レイアウト画像のURL |
layout.field_width | テキスト | フォームフィールドの幅 |
layout.show_progress_bar | はい / いいえ | プログレスバーを表示するかどうか |
type | テキスト | ページタイプ |
index | 数値 | ページ順序インデックス |
created_at | テキスト | ページ作成タイムスタンプ |
updated_at | テキスト | ページの最終更新タイムスタンプ |
content[] | リスト | ページ上の質問のリスト |
content[].id | テキスト | 質問の一意の識別子 |
content[].index | 数値 | 質問の順序インデックス |
content[].type | テキスト | 質問のタイプ |
content[].label | テキスト | 質問ラベル |
content[].name | テキスト | 質問名 |
content[].is_other | はい / いいえ | これが「その他」オプションかどうか |
content[].is_hide | はい / いいえ | 質問が非表示かどうか |
content[].time_format | テキスト | 時間関連の質問の時間形式 |
content[].date_format | テキスト | 日付関連の質問の日付形式 |
content[].dob_enabled | はい / いいえ | 生年月日が有効かどうか |
content[].input_directly_enabled | はい / いいえ | 直接入力が有効かどうか |
content[].fixed_date_title_enabled | はい / いいえ | 固定日付タイトルが有効かどうか |
content[].description | テキスト | 質問の説明 |
content[].icon | テキスト | 質問アイコン |
content[].right_icon | はい / いいえ | アイコンが右側に配置されているかどうか |
content[].supported_types[] | リスト | ファイルアップロード質問でサポートされるファイルタイプ |
content[].theme | テキスト | ファイルアップロードテーマサイズ |
content[].footer_hide | はい / いいえ | フッターを非表示にするかどうか |
content[].max_scale | 数値 | 評価質問の最大スケール値 |
content[].show_number | はい / いいえ | 質問番号を表示するかどうか |
content[].footer_label | オブジェクト | フッターラベル設定 |
content[].footer_label.left | テキスト | 左フッターラベル |
content[].footer_label.middle | テキスト | 中央フッターラベル |
content[].footer_label.right | テキスト | 右フッターラベル |
content[].shape | テキスト | 評価質問の評価形状 |
content[].description_enabled | はい / いいえ | 説明が有効かどうか |
content[].hide_label | はい / いいえ | ラベルを非表示にするかどうか |
content[].placeholder | テキスト | 質問のプレースホルダーテキスト |
content[].validators[] | リスト | 質問バリデーションルール |
content[].validators[].type | テキスト | バリデータータイプ |
content[].validators[].value | オブジェクト | バリデーター値 |
content[].validators[].message | テキスト | バリデーションエラーメッセージ |
content[].style | オブジェクト | 質問スタイリング設定 |
content[].layout | テキスト | 質問レイアウト設定 |
content[].options[] | リスト | 選択ベースの質問の質問オプション |
content[].options[].label | テキスト | オプションラベル |
content[].options[].default_check | はい / いいえ | このオプションがデフォルトでチェックされているかどうか |
content[].options[].image_url | テキスト | オプション画像のURL |
content[].fields[] | リスト | 複雑な質問のサブフィールド |
フォームのすべての質問一覧
フォームのすべての質問を一覧表示します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | すべての質問を一覧表示するフォームID |
| 検索 | テキスト | 質問をフィルタリングする検索語 | |
| フィルター | テキスト | JSONオブジェクトでフィルタリング | |
| ソート | テキスト | 昇順はfield_name、降順は-field_nameでソート。複数の値は「,」区切りでサポート |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
json
[
{
"id": "string",
"page_id": "string",
"form_id": "string",
"page_name": "string",
"name": "string",
"label": "string",
"label_text": "string",
"type": "short_qa",
"options": [],
"is_deleted": false,
"is_hidden": false,
"is_pinned": false
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 質問の一意の識別子 |
page_id | テキスト | 質問を含むページのID |
form_id | テキスト | 質問を含むフォームのID |
page_name | テキスト | 質問を含むページの名前 |
name | テキスト | 質問名 |
label | テキスト | 質問ラベル |
label_text | テキスト | HTMLタグなしの質問ラベル |
type | テキスト | 質問のタイプ |
options[] | リスト | 選択ベースの質問の質問オプション |
is_deleted | はい / いいえ | 質問が削除されているかどうか |
is_hidden | はい / いいえ | 質問が非表示かどうか |
is_pinned | はい / いいえ | 質問がピン留めされているかどうか |
フォームページ更新
フォームページを更新します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | ページを更新するフォームID |
| ページ | リスト | はい | ページ更新の配列 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
json
[
{
"id": "string",
"name": "string",
"layout": {
"type": "image-top-with-space",
"image_url": "string",
"field_width": "string",
"show_progress_bar": false
},
"type": "section",
"index": 0,
"created_at": "2026-01-01T09:00:00Z",
"updated_at": "2026-01-01T09:00:00Z",
"content": [
{
"id": "string",
"index": 0,
"type": "short_qa",
"label": "string",
"name": "string",
"is_other": false,
"is_hide": false,
"time_format": "string",
"date_format": "string",
"dob_enabled": false,
"input_directly_enabled": false,
"fixed_date_title_enabled": false,
"description": "string",
"icon": "string",
"right_icon": false,
"supported_types": [],
"theme": "small",
"footer_hide": false,
"max_scale": 0,
"show_number": true,
"footer_label": {},
"shape": "star",
"description_enabled": false,
"hide_label": false,
"placeholder": "string",
"validators": [],
"style": {},
"layout": "one_column",
"options": [],
"fields": []
}
]
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ページID |
name | テキスト | ページ名 |
layout | オブジェクト | ページレイアウト設定 |
layout.type | 選択 | レイアウトタイプ |
layout.image_url | テキスト | レイアウト画像のURL |
layout.field_width | テキスト | フォームフィールドの幅 |
layout.show_progress_bar | はい / いいえ | プログレスバーを表示するかどうか |
type | テキスト | ページタイプ |
index | 数値 | ページ順序インデックス |
created_at | テキスト | ページ作成タイムスタンプ |
updated_at | テキスト | ページの最終更新タイムスタンプ |
content[] | リスト | ページ上の質問のリスト |
content[].id | テキスト | 質問の一意の識別子 |
content[].index | 数値 | 質問の順序インデックス |
content[].type | テキスト | 質問のタイプ |
content[].label | テキスト | 質問ラベル |
content[].name | テキスト | 質問名 |
content[].is_other | はい / いいえ | これが「その他」オプションかどうか |
content[].is_hide | はい / いいえ | 質問が非表示かどうか |
content[].time_format | テキスト | 時間関連の質問の時間形式 |
content[].date_format | テキスト | 日付関連の質問の日付形式 |
content[].dob_enabled | はい / いいえ | 生年月日が有効かどうか |
content[].input_directly_enabled | はい / いいえ | 直接入力が有効かどうか |
content[].fixed_date_title_enabled | はい / いいえ | 固定日付タイトルが有効かどうか |
content[].description | テキスト | 質問の説明 |
content[].icon | テキスト | 質問アイコン |
content[].right_icon | はい / いいえ | アイコンが右側に配置されているかどうか |
content[].supported_types[] | リスト | ファイルアップロード質問でサポートされるファイルタイプ |
content[].theme | テキスト | ファイルアップロードテーマサイズ |
content[].footer_hide | はい / いいえ | フッターを非表示にするかどうか |
content[].max_scale | 数値 | 評価質問の最大スケール値 |
content[].show_number | はい / いいえ | 質問番号を表示するかどうか |
content[].footer_label | オブジェクト | フッターラベル設定 |
content[].footer_label.left | テキスト | 左フッターラベル |
content[].footer_label.middle | テキスト | 中央フッターラベル |
content[].footer_label.right | テキスト | 右フッターラベル |
content[].shape | テキスト | 評価質問の評価形状 |
content[].description_enabled | はい / いいえ | 説明が有効かどうか |
content[].hide_label | はい / いいえ | ラベルを非表示にするかどうか |
content[].placeholder | テキスト | 質問のプレースホルダーテキスト |
content[].validators[] | リスト | 質問バリデーションルール |
content[].validators[].type | テキスト | バリデータータイプ |
content[].validators[].value | オブジェクト | バリデーター値 |
content[].validators[].message | テキスト | バリデーションエラーメッセージ |
content[].style | オブジェクト | 質問スタイリング設定 |
content[].layout | テキスト | 質問レイアウト設定 |
content[].options[] | リスト | 選択ベースの質問の質問オプション |
content[].options[].label | テキスト | オプションラベル |
content[].options[].default_check | はい / いいえ | このオプションがデフォルトでチェックされているかどうか |
content[].options[].image_url | テキスト | オプション画像のURL |
content[].fields[] | リスト | 複雑な質問のサブフィールド |
回答一覧
フォームのすべての回答を一覧表示します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | すべての回答を一覧表示するフォームID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
json
[
{
"id": "string",
"created_at": "2026-01-01T09:00:00Z",
"created_by": {
"ip": "string",
"user_agent": "string",
"profile": {
"id": "string",
"type": "line",
"name": "string",
"avatar": "string"
}
}
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 回答の一意の識別子 |
created_at | テキスト | 回答作成タイムスタンプ |
created_by | オブジェクト | 回答を作成した人の情報 |
created_by.ip | テキスト | 回答者のIPアドレス |
created_by.user_agent | テキスト | 回答者のブラウザのユーザーエージェント文字列 |
created_by.profile | オブジェクト | 提供された場合のLINEプロフィール |
created_by.profile.id | テキスト | ユーザープロフィールの一意の識別子 |
created_by.profile.type | テキスト | ユーザープロフィールのタイプ（例：line、googleなど） |
created_by.profile.name | テキスト | ユーザーの表示名 |
created_by.profile.avatar | テキスト | ユーザーのアバター画像のURL |
回答取得
フォームの回答を取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 回答を取得するフォームID |
| 回答ID | テキスト | はい | 取得する回答ID |
出力
出力フィールドの定義はありません。
回答作成
フォームの回答を作成します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 回答を作成するフォームID |
| 回答 | リスト | フォームの質問に対する回答の配列 |
出力
出力フィールドの定義はありません。
ビュー一覧
フォームのすべてのビューを一覧表示します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | すべてのビューを一覧表示するフォームID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
json
[
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 結果ビューID |
name | テキスト | ビュー名 |
columns[] | リスト | ビューに表示される質問のリスト |
columns[].label | テキスト | 質問ラベル |
columns[].labelText | テキスト | HTMLタグなしの質問ラベル |
columns[].questionId | テキスト | 質問ID |
columns[].type | テキスト | 質問タイプ |
columns[].isHidden | はい / いいえ | 質問の非表示ステータス |
columns[].isPinned | はい / いいえ | 質問のピン留めステータス |
columns[].isDeleted | はい / いいえ | 削除されているかどうか |
filters | オブジェクト | ビューに適用されるフィルター |
isPrivate | はい / いいえ | ビューの可視性 |
creatorId | テキスト | 結果ビュー作成者ID |
ビュー取得
ビューIDでビューを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | ビューを取得するフォームID |
| ビューID | テキスト | はい | 取得するビューID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 結果ビューID |
name | テキスト | ビュー名 |
columns[] | リスト | ビューに表示される質問のリスト |
columns[].label | テキスト | 質問ラベル |
columns[].labelText | テキスト | HTMLタグなしの質問ラベル |
columns[].questionId | テキスト | 質問ID |
columns[].type | テキスト | 質問タイプ |
columns[].isHidden | はい / いいえ | 質問の非表示ステータス |
columns[].isPinned | はい / いいえ | 質問のピン留めステータス |
columns[].isDeleted | はい / いいえ | 削除されているかどうか |
filters | オブジェクト | ビューに適用されるフィルター |
isPrivate | はい / いいえ | ビューの可視性 |
creatorId | テキスト | 結果ビュー作成者ID |
ビュー作成
新しいビューを作成します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | ビューを作成するフォームID |
| 名前 | テキスト | はい | ビュー名 |
| 列 | リスト | ビューに表示される質問のリスト | |
| フィルター | オブジェクト | ビューに適用されるフィルター |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 結果ビューID |
name | テキスト | ビュー名 |
columns[] | リスト | ビューに表示される質問のリスト |
columns[].label | テキスト | 質問ラベル |
columns[].labelText | テキスト | HTMLタグなしの質問ラベル |
columns[].questionId | テキスト | 質問ID |
columns[].type | テキスト | 質問タイプ |
columns[].isHidden | はい / いいえ | 質問の非表示ステータス |
columns[].isPinned | はい / いいえ | 質問のピン留めステータス |
columns[].isDeleted | はい / いいえ | 削除されているかどうか |
filters | オブジェクト | ビューに適用されるフィルター |
isPrivate | はい / いいえ | ビューの可視性 |
creatorId | テキスト | 結果ビュー作成者ID |
ビュー更新
ビューを更新します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | ビューを更新するフォームID |
| ビューID | テキスト | はい | 更新するビューID |
| 名前 | テキスト | ビュー名 | |
| 列 | リスト | ビューに表示される質問のリスト | |
| フィルター | オブジェクト | ビューに適用されるフィルター | |
| プライベート | はい / いいえ | ビューの可視性 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 結果ビューID |
name | テキスト | ビュー名 |
columns[] | リスト | ビューに表示される質問のリスト |
columns[].label | テキスト | 質問ラベル |
columns[].labelText | テキスト | HTMLタグなしの質問ラベル |
columns[].questionId | テキスト | 質問ID |
columns[].type | テキスト | 質問タイプ |
columns[].isHidden | はい / いいえ | 質問の非表示ステータス |
columns[].isPinned | はい / いいえ | 質問のピン留めステータス |
columns[].isDeleted | はい / いいえ | 削除されているかどうか |
filters | オブジェクト | ビューに適用されるフィルター |
isPrivate | はい / いいえ | ビューの可視性 |
creatorId | テキスト | 結果ビュー作成者ID |
ビュー削除
ビューを削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | ビューを削除するフォームID |
| ビューID | テキスト | はい | 削除するビューID |
出力
出力フィールドの定義はありません。
タグ一覧
オプションのフィルタリングとページネーションでタグのリストを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 検索 | テキスト | タグをフィルタリングする検索語 | |
| フィルター | テキスト | JSONオブジェクトでフィルタリング | |
| ソート | テキスト | 昇順はfield_name、降順は-field_nameでソート。複数の値は「,」区切りでサポート | |
| ページ | 数値 | 一覧表示の選択されたページ 既定値: 1 | |
| ページあたり | 数値 | 1ページあたりのアイテム数 既定値: 10 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば responses[0].id は $.<ステップID>.output.responses[0].id です。
json
{
"responses": [
{
"id": "string",
"name": "string",
"is_category": false
}
],
"pagination": {
"total_item": 0,
"total_page": 0,
"per_page": 0,
"current_page": 0
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
responses[] | リスト | タグの一覧 |
responses[].id | テキスト | タグID |
responses[].name | テキスト | タグ名 |
responses[].is_category | はい / いいえ | タグがカテゴリかどうか |
pagination | オブジェクト | ページネーション情報 |
pagination.total_item | 数値 | 総項目数 |
pagination.total_page | 数値 | 総ページ数 |
pagination.per_page | 数値 | 1ページあたりの項目数 |
pagination.current_page | 数値 | 現在のページ番号 |
タグ取得
特定のタグの詳細情報を取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 取得するタグID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
json
{
"id": "string",
"name": "string",
"is_category": false
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | タグID |
name | テキスト | タグ名 |
is_category | はい / いいえ | タグがカテゴリかどうか |