Download OpenAPI specification:
title required | string (Forms.Models.formTitle) non-empty |
description required | string or null non-empty |
{- "title": "string",
- "description": "string"
}
{- "errorCode": "string",
- "reason": "string"
}
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "settings": {
- "webhook_url": "string",
- "visibility": "PUBLIC",
- "answer_settings": {
- "default_answer_title": "string",
- "visibility": "PUBLIC",
- "response_period": {
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z"
}
}
}
}
]
id required | string <uuid> (Forms.Models.formId) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "settings": {
- "webhook_url": "string",
- "visibility": "PUBLIC",
- "answer_settings": {
- "default_answer_title": "string",
- "visibility": "PUBLIC",
- "response_period": {
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z"
}
}
}
}
id required | string <uuid> (Forms.Models.formId) |
title | string (Forms.Models.formTitle) non-empty |
description | string or null non-empty |
object (Forms.Models.FormSettingsMergePatchUpdate) |
{- "title": "string",
- "description": "string",
- "settings": {
- "webhook_url": "string",
- "visibility": "PUBLIC",
- "answer_settings": {
- "default_answer_title": "string",
- "visibility": "PUBLIC",
- "response_period": {
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z"
}
}
}
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "settings": {
- "webhook_url": "string",
- "visibility": "PUBLIC",
- "answer_settings": {
- "default_answer_title": "string",
- "visibility": "PUBLIC",
- "response_period": {
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z"
}
}
}
}
form_id required | string <uuid> (Forms.Models.formId) |
title required | string (Questions.Models.questionTitle) non-empty |
description required | string (Questions.Models.questionDescription) non-empty |
question_type required | string (Questions.Models.QuestionType) Enum: "TEXT" "SINGLE" "MULTIPLE" |
choices required | Array of strings |
is_required required | boolean |
{- "title": "string",
- "description": "string",
- "question_type": "TEXT",
- "choices": [
- "string"
], - "is_required": true
}
{- "errorCode": "string",
- "reason": "string"
}
form_id required | string <uuid> (Forms.Models.formId) |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "question_type": "TEXT",
- "choices": [
- "string"
], - "is_required": true
}
]
form_id required | string <uuid> (Forms.Models.formId) |
question_id required | string <uuid> (Questions.Models.questionId) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "question_type": "TEXT",
- "choices": [
- "string"
], - "is_required": true
}
form_id required | string <uuid> (Forms.Models.formId) |
question_id required | string <uuid> (Questions.Models.questionId) |
title | string (Questions.Models.questionTitle) non-empty |
description | string (Questions.Models.questionDescription) non-empty |
question_type | string (Questions.Models.QuestionType) Enum: "TEXT" "SINGLE" "MULTIPLE" |
choices | Array of strings |
is_required | boolean |
{- "title": "string",
- "description": "string",
- "question_type": "TEXT",
- "choices": [
- "string"
], - "is_required": true
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "question_type": "TEXT",
- "choices": [
- "string"
], - "is_required": true
}
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
- "contents": [
- {
- "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
- "answer": "string"
}
], - "user": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
]
form_id required | string <uuid> (Forms.Models.formId) |
form_id required | string <uuid> (Forms.Models.formId) |
required | Array of objects (Answers.Models.Answer) |
{- "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
- "contents": [
- {
- "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
- "answer": "string"
}
]
}
{- "errorCode": "string",
- "reason": "string"
}
form_id required | string <uuid> (Forms.Models.formId) |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
- "contents": [
- {
- "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
- "answer": "string"
}
], - "user": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
]
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
- "contents": [
- {
- "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
- "answer": "string"
}
], - "user": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
form_id | string <uuid> (Forms.Models.formId) |
Array of objects (Answers.Models.AnswerMergePatchUpdateReplaceOnly) |
{- "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
- "contents": [
- {
- "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
- "answer": "string"
}
]
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
- "contents": [
- {
- "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
- "answer": "string"
}
], - "user": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
content required | string (Comments.Models.commentContent) non-empty |
{- "content": "string"
}
{- "errorCode": "string",
- "reason": "string"
}
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content": "string",
- "commented_by": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
]
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
comment_id required | string <uuid> (Comments.Models.commentId) |
content | string (Comments.Models.commentContent) non-empty |
{- "content": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content": "string",
- "commented_by": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
comment_id required | string <uuid> (Comments.Models.commentId) |
{- "errorCode": "string",
- "reason": "string"
}
id required | string <uuid> (Users.Models.userId) |
uuid | string <uuid> (Users.Models.userId) |
name | string (Users.Models.userName) non-empty |
role | string (Users.Models.Role) Enum: "STANDARD_USER" "ADMINISTRATOR" |
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
body required | string (Messages.Models.messageBody) |
{- "body": "string"
}
{- "errorCode": "string",
- "reason": "string"
}
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "sender": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "body": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}
]
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
message_id required | string <uuid> (Messages.Models.messageId) |
body | string (Messages.Models.messageBody) |
{- "body": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "sender": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "body": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}
form_id required | string <uuid> (Forms.Models.formId) |
answer_id required | string <uuid> (Answers.Models.answerId) |
message_id required | string <uuid> (Messages.Models.messageId) |
{- "errorCode": "string",
- "reason": "string"
}
name required | string (LabelForAnswers.Models.labelNameForAnswers) non-empty |
{- "name": "string"
}
{- "errorCode": "string",
- "reason": "string"
}
label_id required | string <uuid> (LabelForAnswers.Models.labelForAnswersId) |
name | string (LabelForAnswers.Models.labelNameForAnswers) non-empty |
{- "name": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
name required | string (LabelForForm.Models.labelNameForForm) non-empty |
{- "name": "string"
}
{- "errorCode": "string",
- "reason": "string"
}
label_id required | string <uuid> (LabelForForm.Models.labelForFormId) |
name | string (LabelForForm.Models.labelNameForForm) non-empty |
{- "name": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
{- "forms": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "settings": {
- "webhook_url": "string",
- "visibility": "PUBLIC",
- "answer_settings": {
- "default_answer_title": "string",
- "visibility": "PUBLIC",
- "response_period": {
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z"
}
}
}
}
], - "users": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}
], - "answers": [
- {
- "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
- "answer": "string"
}
], - "comments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content": "string",
- "commented_by": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "role": "STANDARD_USER"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
], - "label_for_forms": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "label_for_answers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}
is_send_message_notification | boolean |
{- "is_send_message_notification": true
}
{- "is_send_message_notification": true
}
token required | string (External.Models.discordOAuthToken) |
{- "token": "string"
}
{- "errorCode": "string",
- "reason": "string"
}