API docs by Redocly

Seichi Portal API (v0.0.1)

Download OpenAPI specification:

Forms

フォームの作成

Authorizations:
BearerAuth
Request Body schema: application/json
required
title
required
string (Forms.Models.formTitle) non-empty
description
required
string (Forms.Models.formDescription) >= 0 characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "settings": {
    }
}

フォームの一覧取得

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

フォームの取得

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

フォームの更新

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 (Forms.Models.formDescription) >= 0 characters
object (Forms.Models.FormSettingsMergePatchUpdate)

Responses

Request samples

Content type
application/merge-patch+json
{
  • "title": "string",
  • "description": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "settings": {
    }
}

フォームの削除

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid> (Forms.Models.formId)

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "reason": "string"
}

Questions

質問の一覧取得

Authorizations:
BearerAuth
path Parameters
form_id
required
string <uuid> (Forms.Models.formId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

質問の上書き

Authorizations:
BearerAuth
path Parameters
form_id
required
string <uuid> (Forms.Models.formId)

Responses

Response samples

Content type
application/json
{
  • "questions": [
    ]
}

Answers

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

回答の作成

Authorizations:
BearerAuth
path Parameters
form_id
required
string <uuid> (Forms.Models.formId)
Request Body schema: application/json
required
required
Array of objects (Answers.Models.Answer)

Responses

Request samples

Content type
application/json
{
  • "contents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contents": [
    ],
  • "user": {
    },
  • "timestamp": "2019-08-24T14:15:22Z"
}

回答の一覧取得

Authorizations:
BearerAuth
path Parameters
form_id
required
string <uuid> (Forms.Models.formId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

回答の取得

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",
  • "contents": [
    ],
  • "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
Array of objects (Answers.Models.AnswerMergePatchUpdateReplaceOnly)

Responses

Request samples

Content type
application/merge-patch+json
{
  • "contents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contents": [
    ],
  • "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

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content": "string",
  • "commented_by": {
    },
  • "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
[
  • {
    }
]

コメントの編集

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

Content type
application/merge-patch+json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content": "string",
  • "commented_by": {
    },
  • "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

Content type
application/json
{
  • "errorCode": "string",
  • "reason": "string"
}

Users

ユーザーの一覧取得

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "role": "STANDARD_USER"
}

ユーザーの取得

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid> (Users.Models.userId)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "role": "STANDARD_USER"
}

ユーザーの更新

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid> (Users.Models.userId)
Request Body schema: application/merge-patch+json
required
id
string <uuid> (Users.Models.userId)
name
string (Users.Models.userName) non-empty
role
string (Users.Models.Role)
Enum: "STANDARD_USER" "ADMINISTRATOR"

Responses

Request samples

Content type
application/merge-patch+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "role": "STANDARD_USER"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "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

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sender": {
    },
  • "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)

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

メッセージの編集

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

Content type
application/merge-patch+json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sender": {
    },
  • "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

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

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

回答用ラベルを更新する

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

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

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

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

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

Content type
application/json
{
  • "errorCode": "string",
  • "reason": "string"
}

Search

横断検索を行う

Authorizations:
BearerAuth
query Parameters
query
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "forms": [
    ],
  • "users": [
    ],
  • "answers": [
    ],
  • "comments": [
    ],
  • "label_for_forms": [
    ],
  • "label_for_answers": [
    ]
}

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

Content type
application/merge-patch+json
{
  • "is_send_message_notification": true
}

Response samples

Content type
application/json
{
  • "is_send_message_notification": true
}

通知の設定を取得する

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid> (Users.Models.userId)

Responses

Response samples

Content type
application/json
{
  • "is_send_message_notification": true
}

Session

セッションを作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required
expires
required
integer <int64> [ 0 .. 4294967295 ]

Responses

Request samples

Content type
application/json
{
  • "expires": 4294967295
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "reason": "string"
}

セッションを削除する

Authorizations:
BearerAuth

Responses

Response samples

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

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "reason": "string"
}

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "reason": "string"
}