GET/forms/{formId}/responses

アンケートの回答結果を取得する。
アンケートの作成者または共同管理者が結果を取得できる。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

form
form.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/forms/{formId}/responses

Path Parameters

ParameterTypeDescription
formId string 

アンケート ID

formId の取得方法 を参照ください。


required
example : 11e4316cb72f3373a4a0780ac6de6440 

Query Parameters

ParameterTypeDescription
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

取得数


default : 500
minimum : 0
maximum : 1000
example : 300
format : int32 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
responses array (response) 
 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

response

PropertyTypeDescription
formId string 

アンケート ID

 
responseId string 

回答 ID

 
respondedTime string 

回答時刻

 
respondent object (respondent) 

回答者

 
questions array (qeustion) 
 

respondent

PropertyTypeDescription
id string 

回答者のユーザー ID

 
name string 

回答者名

 
email string 

回答者の email

 
organizationName string 

回答者の会社名

 
orgUnitName string 

回答者の組織名

 

qeustion

PropertyTypeDescription
questionId string 

質問 ID

 
questionType string 

質問タイプ

  • SINGLE_CHOICE: 選択式
  • MULTIPLE_CHOICE: 選択式 (複数)
  • TEXT: 記述式
  • SINGLE_DATE: 日程投票
  • MULTIPLE_DATE: 日程投票 (複数)
  • DROPDOWN: プルダウンリスト
  • RATING: 評価スコア式
  • DATE_INPUT: 日付を入力
  • DATETIME_INPUT: 日付/時間を入力
  • ATTACHMENT: 画像ファイルを選択

Allowed values : SINGLE_CHOICE, MULTIPLE_CHOICE, TEXT, SINGLE_DATE, MULTIPLE_DATE, DROPDOWN, RATING, DATE_INPUT, DATETIME_INPUT, ATTACHMENT 
title string 

質問のタイトル

 
description string 

質問の説明

 
required boolean 

回答必須

 
answers array (string) 

回答データ。文字列の配列で受け取ります。

補足 を参照ください。

 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

Example 1

1{2  "responses": [3    {4      "formId": "7b19cbe30f1032a99f8a8621733aad70",5      "responseId": "d68d16bd6f453403a46256f64be2abdb",6      "respondedTime": "2024-08-28T17:01:44+09:00",7      "respondent": {8        "id": "725dc47e-fbee-404c-16ad-03ab80cee0c3",9        "name": "ワークス太郎",10        "email": "localpart@example.com",11        "organizationName": "org",12        "orgUnitName": "組織"13      },14      "questions": [15        {16          "questionId": "1f8775e0b52c",17          "questionType": "SINGLE_CHOICE",18          "title": "質問タイトル",19          "description": "質問の説明",20          "required": true,21          "answers": [22            "項目 1"23          ]24        }25      ]26    }27  ],28  "responseMetaData": {29    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"30  }31}

Example 2

1{2  "responses": [3    {4      "formId": "666576810dbe30dd927b8ef09d15a6a3",5      "responseId": "df5552c6581e329d8ba56f71212ef16b",6      "respondedTime": "2024-08-28T17:01:44+09:00",7      "questions": [8        {9          "questionId": "68629fb28e88",10          "title": "質問タイトル",11          "questionType": "MULTIPLE_CHOICE",12          "description": "質問の説明",13          "required": true,14          "answers": [15            "項目 1",16            "項目 2"17          ]18        }19      ]20    }21  ],22  "responseMetaData": {23    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"24  }25}

Example 3

1{2  "responses": [3    {4      "formId": "666576810dbe30dd927b8ef09d15a6a3",5      "responseId": "df5552c6581e329d8ba56f71212ef16b",6      "respondedTime": "2024-08-28T17:01:44+09:00",7      "questions": [8        {9          "questionId": "68629fb28e88",10          "questionType": "ATTACHMENT",11          "title": "質問のタイトル",12          "description": "質問の説明",13          "required": true,14          "answers": [15            "1122706"16          ]17        }18      ]19    }20  ],21  "responseMetaData": {22    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"23  }24}