Seichi Portal API (0.0.0)

Download OpenAPI specification:

Forms

フォームの作成

Authorizations:

BearerAuth

Request Body schema: application/json
required

title required	string (Forms.Models.formTitle) non-empty
description required	string or null non-empty

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string"
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

フォームの一覧取得

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"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"
}
}
}
}
]

フォームの取得

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (Forms.Models.formId)

Responses

Response samples

Content type

application/json

{"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"
}
}
}
}

フォームの更新

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (Forms.Models.formId)

Request Body schema: application/merge-patch+json
required

title	string (Forms.Models.formTitle) non-empty
description	string or null non-empty
	object (Forms.Models.FormSettingsMergePatchUpdate)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"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"
}
}
}
}

Response samples

Content type

application/json

{"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"
}
}
}
}

フォームの削除

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (Forms.Models.formId)

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

Questions

質問の作成

Authorizations:

BearerAuth

path Parameters

form_id

required

string <uuid> (Forms.Models.formId)

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

質問の一覧取得

Authorizations:

BearerAuth

path Parameters

form_id

required

string <uuid> (Forms.Models.formId)

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}
]

質問の取得

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
question_id required	string <uuid> (Questions.Models.questionId)

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}

質問の更新

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
question_id required	string <uuid> (Questions.Models.questionId)

Request Body schema: application/merge-patch+json
required

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

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}

質問の削除

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
question_id required	string <uuid> (Questions.Models.questionId)

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

Answers

すべての回答をフォームを横断して取得

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"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"
}
]

回答の作成

Authorizations:

BearerAuth

path Parameters

form_id

required

string <uuid> (Forms.Models.formId)

Request Body schema: application/json
required

form_id required	string <uuid> (Forms.Models.formId)
required	Array of objects (Answers.Models.Answer)

Responses

Request samples

Payload

Content type

application/json

{"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"contents": [{"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"answer": "string"
}
]
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

回答の一覧取得

Authorizations:

BearerAuth

path Parameters

form_id

required

string <uuid> (Forms.Models.formId)

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"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"
}
]

回答の取得

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)

Responses

Response samples

Content type

application/json

{"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"
}

回答の更新

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)

Request Body schema: application/merge-patch+json
required

form_id	string <uuid> (Forms.Models.formId)
	Array of objects (Answers.Models.AnswerMergePatchUpdateReplaceOnly)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"contents": [{"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"answer": "string"
}
]
}

Response samples

Content type

application/json

{"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"
}

Comments

コメントの作成

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)

Request Body schema: application/json
required

content

required

string (Comments.Models.commentContent) non-empty

Responses

Request samples

Payload

Content type

application/json

{"content": "string"
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

コメントの取得

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"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"
}
]

コメントの編集

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)
comment_id required	string <uuid> (Comments.Models.commentId)

Request Body schema: application/merge-patch+json
required

content

string (Comments.Models.commentContent) non-empty

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"content": "string"
}

Response samples

Content type

application/json

{"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"
}

コメントの削除

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)
comment_id required	string <uuid> (Comments.Models.commentId)

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

Users

ユーザーの一覧取得

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"role": "STANDARD_USER"
}
]

自分のユーザー情報の取得

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"role": "STANDARD_USER"
}

ユーザーの取得

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (Users.Models.userId)

Responses

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"role": "STANDARD_USER"
}

ユーザーの更新

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (Users.Models.userId)

Request Body schema: application/merge-patch+json
required

uuid	string <uuid> (Users.Models.userId)
name	string (Users.Models.userName) non-empty
role	string (Users.Models.Role) Enum: "STANDARD_USER" "ADMINISTRATOR"

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"role": "STANDARD_USER"
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"role": "STANDARD_USER"
}

Messages

メッセージの作成

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)

Request Body schema: application/json
required

body

required

string (Messages.Models.messageBody)

Responses

Request samples

Payload

Content type

application/json

{"body": "string"
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

メッセージの取得

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"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"
}
]

メッセージの編集

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)
message_id required	string <uuid> (Messages.Models.messageId)

Request Body schema: application/merge-patch+json
required

body	string (Messages.Models.messageBody)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"body": "string"
}

Response samples

Content type

application/json

{"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"
}

メッセージの削除

Authorizations:

BearerAuth

path Parameters

form_id required	string <uuid> (Forms.Models.formId)
answer_id required	string <uuid> (Answers.Models.answerId)
message_id required	string <uuid> (Messages.Models.messageId)

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

LabelForAnswers

回答用ラベルを作成する

Authorizations:

BearerAuth

Request Body schema: application/json
required

name

required

string (LabelForAnswers.Models.labelNameForAnswers) non-empty

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

回答用ラベルの一覧を取得する

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]

回答用ラベルを取得する

Authorizations:

BearerAuth

path Parameters

label_id

required

string <uuid> (LabelForAnswers.Models.labelForAnswersId)

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

回答用ラベルを更新する

Authorizations:

BearerAuth

path Parameters

label_id

required

string <uuid> (LabelForAnswers.Models.labelForAnswersId)

Request Body schema: application/merge-patch+json
required

name	string (LabelForAnswers.Models.labelNameForAnswers) non-empty

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

回答用ラベルを削除する

Authorizations:

BearerAuth

path Parameters

label_id

required

string <uuid> (LabelForAnswers.Models.labelForAnswersId)

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

LabelForForm

フォーム用ラベルを作成する

Authorizations:

BearerAuth

Request Body schema: application/json
required

name

required

string (LabelForForm.Models.labelNameForForm) non-empty

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

フォーム用ラベルの一覧を取得する

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]

フォーム用ラベルを取得する

Authorizations:

BearerAuth

path Parameters

label_id

required

string <uuid> (LabelForForm.Models.labelForFormId)

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

フォーム用ラベルを更新する

Authorizations:

BearerAuth

path Parameters

label_id

required

string <uuid> (LabelForForm.Models.labelForFormId)

Request Body schema: application/merge-patch+json
required

name	string (LabelForForm.Models.labelNameForForm) non-empty

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

フォーム用ラベルを削除する

Authorizations:

BearerAuth

path Parameters

label_id

required

string <uuid> (LabelForForm.Models.labelForFormId)

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

Search

横断検索を行う

Authorizations:

BearerAuth

query Parameters

query

required

string

Responses

Response samples

Content type

application/json

{"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"
}
]
}

Notifications

通知設定の取得

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

{"is_send_message_notification": true
}

通知設定の更新

Authorizations:

BearerAuth

Request Body schema: application/merge-patch+json
required

is_send_message_notification

boolean

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"is_send_message_notification": true
}

Response samples

Content type

application/json

{"is_send_message_notification": true
}

Session

セッションを作成する

Authorizations:

BearerAuth

Request Body schema: application/json
required

expires

required

integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"expires": 0
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

セッションを削除する

Authorizations:

BearerAuth

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

External

Discord アカウントとリンクする

Authorizations:

BearerAuth

Request Body schema: application/json
required

token

required

string (External.Models.discordOAuthToken)

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

Discord アカウントとのリンクを解除する

Authorizations:

BearerAuth

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "string",
"reason": "string"
}

Seichi Portal API (0.0.0)

Forms

フォームの作成

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

フォームの一覧取得

Authorizations:

Responses

Response samples

フォームの取得

Authorizations:

path Parameters

Responses

Response samples

フォームの更新

Authorizations:

path Parameters

Request Body schema: application/merge-patch+jsonrequired

Responses

Request samples

Response samples

フォームの削除

Authorizations:

path Parameters

Responses

Response samples

Questions

質問の作成

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

質問の一覧取得

Authorizations:

path Parameters

Responses

Response samples

質問の取得

Authorizations:

path Parameters

Responses

Response samples

質問の更新

Authorizations:

path Parameters

Request Body schema: application/merge-patch+jsonrequired

Responses

Request samples

Response samples

質問の削除

Authorizations:

path Parameters

Responses

Response samples

Answers

すべての回答をフォームを横断して取得

Authorizations:

Responses

Response samples

回答の作成

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

回答の一覧取得

Authorizations:

path Parameters

Responses

Response samples

回答の取得

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required