GET/forms/{formId}/responses

설문 응답 결과를 조회한다.
설문의 작성자 혹은 공동 관리자만 조회할 수 있다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

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 

다음 목록 조회 시 사용하는 값


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 (question) 
 

respondent

PropertyTypeDescription
id string 

응답자의 사용자 ID

 
name string 

응답자 이름

 
email string 

응답자 이메일

 
organizationName string 

응답자 회사명

 
orgUnitName string 

응답자 조직명

 

question

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": "penguin@wdomain6.com",11        "organizationName": "한국주식회사",12        "orgUnitName": "펭귄 Dev"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}