설문 상세정보 가져오기

특정 설문(form_id) 상세정보를 가져옵니다.

[GET] https://api.moaform.com/v1/forms/{form_id}

 

요청

Path Parameters

KeyDescription
form_id필수, 설문의 고유 ID

 

응답

KeyTypeDescription
long_idstring설문의 고유 ID
idstringlong_id가 공식적인 설문 ID입니다. 과거 버전과의 호환성을 위해 id도 한시적으로 동작하지만, 앞으로 지원이 중단될 예정입니다. 가능한 long_id를 사용해 주세요.
namestring설문 파일 이름
statusstring설문 진행 상태 (editing, pending, collecting, closed 중 하나)
pages[object] 
↳ idstring페이지의 고유 ID
↳ numberinteger페이지 번호
↳ visibleboolean페이지 노출 여부
↳ blocks_countinteger포함한 항목 개수
blocks[object](아래 별도 table 에서 설명. 각 blocks 별로 아래 ... 위치를 대체)
.........
welcome_pageobject 
↳ contentstring소개글 내용
thankyou_pages[object] 
↳ idstring맺음말 페이지 고유 id
↳ contentstring맺음말 내용
variables[object] 
↳ idstring정의된 변수의 고유 id
↳ namestring정의된 변수 이름
↳ formulastring정의된 변수 수식
ownedboolean 
created_atstring설문 생성 일시
last_updated_atstring설문 최종 수정 일시
published_atstring설문 최종 게시 일시

 

blocks 질문 유형별 상세 (위 응답 표의 blocks 아래 위치함)

정보

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringinformation
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring정보글 내용
↳ ribbon_textstring정보글 제목
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
↳ page_idstring페이지의 고유 ID

 

장식선

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringline_shape
↳ indexstringP1B1형태의 항목 번호형식
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ shapestring선모양 (zigzag...)
↳ page_idstring페이지의 고유 ID

 

객관식 한 개 선택

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringsingle_choice
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ allow_other_choiceboolean기타 보기 허용 여부
     ↳ randomizeboolean보기 무작위 배열 여부
     ↳ assign_scoreboolean점수 할당 여부
     ↳ choices[object] 
          ↳ idstring보기의 고유 ID
          ↳ indexstringP1B1C1형태의 보기 번호형식
          ↳ labelstring보기 내용
          ↳ scoreinteger보기에 할당된 점수
          ↳ visibleboolean보기 노출 여부
          ↳ is_otherboolean기타 보기 여부 (allow_other_choice=true 일때만 나옴)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_otherboolean기타 답변 입력 필수 여부
↳ page_idstring페이지의 고유 ID

 

드롭다운

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringdropdown
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ allow_other_choiceboolean기타 보기 허용 여부
     ↳ randomizeboolean보기 무작위 배열 여부
     ↳ assign_scoreboolean점수 할당 여부
     ↳ choices[object] 
          ↳ idstring보기의 고유 ID
          ↳ indexstringP1B1C1형태의 보기 번호형식
          ↳ labelstring보기 내용
          ↳ scoreinteger보기에 할당된 점수
          ↳ visibleboolean보기 노출 여부
          ↳ is_otherboolean기타 보기 여부 (allow_other_choice=true 일때만 나옴)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_otherboolean기타 답변 입력 필수 여부 (allow_other_choice=true 일때만 나옴)
↳ page_idstring페이지의 고유 ID

 

객관식 복수 선택

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringmultiple_choice
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ allow_other_choiceboolean기타 보기 허용 여부
     ↳ randomizeboolean보기 무작위 배열 여부
     ↳ assign_scoreboolean점수 할당 여부
     ↳ choices[object] 
          ↳ idstring보기의 고유 ID
          ↳ indexstringP1B1C1형태의 보기 번호형식
          ↳ labelstring보기 내용
          ↳ scoreinteger보기에 할당된 점수
          ↳ visibleboolean보기 노출 여부
          ↳ is_otherboolean기타 보기 여부 (allow_other_choice=true 일때만 나옴)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_otherboolean기타 답변 입력 필수 여부 (allow_other_choice=true 일때만 나옴)
     ↳ min_selectioninteger최소 보기 선택 개수
     ↳ max_selectioninteger최대 보기 선택 개수
↳ page_idstring페이지의 고유 ID

 

순위형

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringranking
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ properties[object] 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ allow_other_choiceboolean기타 보기 허용 여부
     ↳ randomizeboolean보기 무작위 배열 여부
     ↳ choices[object] 
          ↳ idstring보기의 고유 ID
          ↳ indexstringP1B1C1형태의 보기 번호형식
          ↳ labelstring보기 내용
          ↳ visibleboolean보기 노출 여부
          ↳ is_otherboolean기타 보기 여부 (allow_other_choice=true 일때만 나옴)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_otherboolean기타 답변 입력 필수 여부 (allow_other_choice=true 일때만 나옴)
     ↳ min_selectioninteger최소 보기 선택 개수
     ↳ max_selectioninteger최대 보기 선택 개수
↳ page_idstring페이지의 고유 ID

 

격자형 한 개 선택

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringmatrix_single_choice
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ assign_scoreboolean점수 할당 여부
↳ blocks[object] 
     ↳ idstring소질문의 고유 ID
     ↳ indexstringP1B1.1형태의 소질문 번호형식
     ↳ contentstring소질문 내용
     ↳ visibleboolean소질문 노출 여부
     ↳ propertiesobject 
          ↳ choices[object] 
               ↳ idstring보기의 고유 ID
               ↳ indexstringP1B1.1C1형태의 보기 번호형식
               ↳ labelstring보기 내용
               ↳ scoreinteger보기에 할당된 점수
               ↳ visibleboolean보기 노출 여부
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
↳ page_idstring페이지의 고유 ID

 

격자형 복수 선택

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringmatrix_multiple_choice
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ assign_scoreboolean점수 할당 여부
↳ blocks[object] 
     ↳ idstring소질문의 고유 ID
     ↳ indexstringP1B1.1형태의 소질문 번호형식
     ↳ contentstring소질문 내용
     ↳ visibleboolean소질문 노출 여부
     ↳ propertiesobject 
          ↳ choices[object] 
               ↳ idstring보기의 고유 ID
               ↳ indexstringP1B1.1C1형태의 보기 번호형식
               ↳ labelstring보기 내용
               ↳ scoreinteger보기에 할당된 점수
               ↳ visibleboolean보기 노출 여부
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ min_selectioninteger최소 보기 선택 개수
     ↳ max_selectioninteger최대 보기 선택 개수
↳ page_idstring페이지의 고유 ID

 

격자형 순위형

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringmatrix_ranking
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
↳ blocks[object] 
     ↳ idstring소질문의 고유 ID
     ↳ indexstringP1B1.1형태의 소질문 번호형식
     ↳ contentstring소질문 내용
     ↳ visibleboolean소질문 노출 여부
     ↳ propertiesobject 
          ↳ choices[object] 
               ↳ idstring보기의 고유 ID
               ↳ indexstringP1B1.1C1형태의 보기 번호형식
               ↳ labelstring보기 내용
               ↳ visibleboolean보기 노출 여부
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ min_selectioninteger최소 보기 선택 개수
     ↳ max_selectioninteger최대 보기 선택 개수
↳ page_idstring페이지의 고유 ID

 

미디어 한 개 선택

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringmedia_single_choice
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ allow_other_choiceboolean기타 보기 허용 여부
     ↳ randomizeboolean보기 무작위 배열 여부
     ↳ assign_scoreboolean점수 할당 여부
     ↳ choices[object] 
          ↳ idstring보기의 고유 ID
          ↳ indexstringP1B1C1형태의 보기 번호형식
          ↳ labelstring보기 내용
          ↳ scoreinteger보기에 할당된 점수
          ↳ visibleboolean보기 노출 여부
          ↳ is_otherboolean기타 보기 여부 (allow_other_choice = true 일때만 나옴)
          ↳ mediaobject첨부한 이미지가 없거나 기타일때는 이 항목은 나오지 않음
               ↳ typestring미디어 종류 (현재는 image로만 반환)
               ↳ urlstring이미지 링크 주소
               ↳ widthinteger이미지 width
               ↳ heightinteger이미지 height
     ↳ mediaobject 
          ↳ fillstring보기내 이미지 채우기
          ↳ sizestring보기내 이미지 사이즈
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_otherboolean기타 답변 입력 필수 여부 (allow_other_choice=true 일때만 나옴)
↳ page_idstring페이지의 고유 ID

 

미디어 복수 선택

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringmedia_multiple_choice
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ allow_other_choiceboolean기타 보기 허용 여부
     ↳ randomizeboolean보기 무작위 배열 여부
     ↳ assign_scoreboolean점수 할당 여부
     ↳ choices[object] 
          ↳ idstring보기의 고유 ID
          ↳ indexstringP1B1C1형태의 보기 번호형식
          ↳ labelstring보기 내용
          ↳ scoreinteger보기에 할당된 점수
          ↳ visibleboolean보기 노출 여부
          ↳ is_otherboolean기타 보기 여부 (allow_other_choice = true일때만 나옴)
          ↳ mediaobject첨부한 이미지가 없거나 기타일때는 이 항목은 나오지 않음
               ↳ typestring미디어 종류 (현재는 image로만 반환)
               ↳ urlstring이미지 링크 주소
               ↳ widthinteger이미지 width
               ↳ heightinteger이미지 height
     ↳ mediaobject 
          ↳ fillstring보기내 이미지 채우기
          ↳ sizestring보기내 이미지 사이즈
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_otherboolean기타 답변 입력 필수 여부 (allow_other_choice=true 일때만 나옴)
     ↳ min_selectioninteger최소 보기 선택 개수
     ↳ max_selectioninteger최대 보기 선택 개수
↳ page_idstring페이지의 고유 ID

 

미디어 순위형

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringmedia_ranking
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ allow_other_choiceboolean기타 보기 허용 여부
     ↳ randomizeboolean보기 무작위 배열 여부
     ↳ choices[object] 
          ↳ idstring보기의 고유 ID
          ↳ indexstringP1B1C1형태의 보기 번호형식
          ↳ labelstring보기 내용
          ↳ scoreinteger보기에 할당된 점수
          ↳ visibleboolean보기 노출 여부
          ↳ is_otherboolean기타 보기 여부 (allow_other_choice = true일때만 나옴)
          ↳ mediaobject첨부한 이미지가 없거나 기타일때는 이 항목은 나오지 않음
               ↳ typestring미디어 종류 (현재는 image로만 반환)
               ↳ urlstring이미지 링크 주소
               ↳ widthinteger이미지 width
               ↳ heightinteger이미지 height
     ↳ mediaobject 
          ↳ fillstring보기내 이미지 채우기
          ↳ sizestring보기내 이미지 사이즈
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_otherboolean기타 답변 입력 필수 여부 (allow_other_choice=true 일때만 나옴)
     ↳ min_selectioninteger최소 보기 선택 개수
     ↳ max_selectioninteger최대 보기 선택 개수
↳ page_idstring페이지의 고유 ID

 

척도형

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringpoint_scale
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ shapeboolean척도 모양
     ↳ stepsinteger척도 단계
     ↳ scales[integer]척도 범위 (예: [-5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5])
     ↳ label[object] 
         ↳ leftstring척도 좌측 문구
          ↳ centerstring척도 가운데 문구
          ↳ rightstring척도 우측 문구
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
↳ page_idstring페이지의 고유 ID

 

NPS

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringnps
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ shapeboolean척도 모양
     ↳ stepsinteger척도 단계 (11로 고정)
     ↳ scales[integer]척도 범위 ([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]로 고정)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
↳ page_idstring페이지의 고유 ID

 

별점형

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringrating
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ shapeboolean별점형 모양
     ↳ stepsinteger별점 단계
     ↳ show_step_countboolean점수 표시 여부
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
↳ page_idstring페이지의 고유 ID

 

주관식 긴 답변 (자유형식)

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringlong_text
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ formatstring답변 형식 설정 (free, regex)
     ↳ guide_phrasestring안내 문구
     ↳ sizestring입력칸 크기 (large, small)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ min_characterinteger최소 글자수(기본값 1)
     ↳ max_characterinteger최대 글자수(기본값 null: 무제한)
↳ page_idstring페이지의 고유 ID

 

주관식 긴 답변 (정규표현식)

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringlong_text
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ formatstring답변 형식 설정 (free, regex)
     ↳ error_textstring오류 메시지
     ↳ guide_phrasestring안내 문구
     ↳ sizestring입력칸 크기 (large, small)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ conditionstring정규 표현식 데이터 조건
     ↳ patternstring정규 표현식 데이터 패턴
↳ page_idstring페이지의 고유 ID

 

주관식 짧은 답변 (자유형식)

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringshort_text
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ formatstring답변 형식 설정 (free, regex)
     ↳ guide_phrasestring안내 문구
     ↳ sizestring입력칸 크기 (long, medium)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ min_characterinteger최소 글자수(기본값 1)
     ↳ max_characterinteger최대 글자수(기본값 null: 무제한)
     ↳ no_spacingboolean띄워쓰기 금지 여부
↳ page_idstring페이지의 고유 ID

 

주관식 짧은 답변 (정규표현식)

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringshort_text
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ formatstring답변 형식 설정 (free, regex)
     ↳ error_textstring오류 메시지
     ↳ guide_phrasestring안내 문구
     ↳ sizestring입력칸 크기 (long, medium)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ conditionstring정규 표현식 데이터 조건
     ↳ patternstring정규 표현식 데이터 패턴
↳ page_idstring페이지의 고유 ID

 

수치입력형

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringnumeric_value
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ guide_phrasestring안내 문구
     ↳ sizestring입력칸 크기 (long, medium)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ decimal_placesinteger소수점 제한(0 ~ 5)
     ↳ min_numberinteger입력 범위(최소값)
     ↳ max_numberinteger입력 범위(최대값)
↳ page_idstring페이지의 고유 ID

 

이메일 주소

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringemail
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ guide_phrasestring안내 문구
     ↳ sizestring 입력칸 크기 (long, medium)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
↳ page_idstring페이지의 고유 ID

 

웹주소

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringurl
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ guide_phrasestring안내 문구
     ↳ sizestring 입력칸 크기 (long, medium)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
↳ page_idstring페이지의 고유 ID

 

주소

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringaddress
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
     ↳ encrypted_answerboolean답변 암호화 저장 여부
     ↳ address_typestring주소 형식 (general, korean)
     ↳ visible_fields[string]노출되는 주소 필드 (street, detail, city, region, postal_code, country)
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ required_fields[string]필수 입력 주소 필드 (street, detail, city,r egion, postal_code, country)
↳ page_idstring페이지의 고유 ID

 

파일 업로드

KEYTypeDescription
↳ idstring항목의 고유 ID
↳ typestringfile_upload
↳ indexstringP1B1형태의 항목 번호형식
↳ contentstring질문 내용
↳ propertiesobject 
     ↳ visibleboolean항목 노출 여부
     ↳ hide_resultboolean결과 비공개 여부
↳ validationsobject 
     ↳ requiredboolean답변 필수 여부
     ↳ file_extensionsstring업로드 가능한 파일 확장자 종류 (콤마로 구분하는 문자열)
     ↳ min_filesinteger업로드 가능한 최소 파일 개수
     ↳ max_filesinteger업로드 가능한 최대 파일 개수
↳ page_idstring페이지의 고유 ID