seichi-portal-api-schema (0.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Forms

フォームの新規作成

フォームを新しく作ります。

作られたフォームのIDがJSONとして返却され、作成されたフォームへのURLを含むHeaderが返されます。

Authorizations:

BearerAuth

Request Body schema: application/json
required

title required	string
description	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

201
400
401
403
500

Content type

application/json

{"id": 0
}

フォームの一覧取得

このエンドポイントでは最小限のフォーム情報を含むリストが返されます。

また、取得パラメータとしてlimitとoffsetを指定し、取得件数を絞り込むことができます。レスポンス内容はid基準とし、昇順ソートしたものになります。 ※各フォームの詳細情報などは別APIを利用することを想定しています。

Authorizations:

BearerAuth

query Parameters

offset	integer <uint32> >= 0 取得件数の下限値例えば、offsetを1とすると2件目からのデータが取得できます。
limit	integer <uint32> >= 1 取得件数の上限値例えば、limitを10とすると10番目までのデータが取得できます。

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"id": 0,
"title": "string",
"description": "string",
"response_period": {"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z"
},
"answer_visibility": "PUBLIC"
}
]

回答の一覧取得

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"id": 0,
"user": {"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
},
"form_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"title": "string",
"answers": [{"question_id": 0,
"answer": "string"
}
],
"comments": [{"content": "string",
"timestamp": "2019-08-24T14:15:22Z",
"commented_by": {"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
}
}
],
"labels": [{"id": 0,
"name": "string"
}
]
}
]

指定されたフォームに回答を追加する

Authorizations:

BearerAuth

Request Body schema: application/json
required

form_id required	integer <uint32>
required	Array of objects (RealAnswer)

Responses

Request samples

Payload

Content type

application/json

{"form_id": 0,
"answers": [{"answer": "string"
}
]
}

Response samples

201
400
401
403
500

Content type

application/json

{"id": 0
}

回答にコメントを追加する

Authorizations:

BearerAuth

Request Body schema: application/json
required

answer_id required	integer <uint32>
content required	string

Responses

Request samples

Payload

Content type

application/json

{"answer_id": 0,
"content": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

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

回答のコメントを更新する

Authorizations:

BearerAuth

Request Body schema: application/json
required

comment_id	integer <uint32>
content	string

Responses

Request samples

Payload

Content type

application/json

{"comment_id": 0,
"content": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

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

回答のコメントを削除する

Authorizations:

BearerAuth

path Parameters

comment_id

required

integer <uint32>

Responses

Response samples

400
401
403
404
500

Content type

application/json

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

回答の取得

Authorizations:

BearerAuth

path Parameters

answerId

required

integer <uint32>

Responses

Response samples

Content type

application/json

{"id": 0,
"user": {"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
},
"form_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"title": "string",
"answers": [{"question_id": 0,
"answer": "string"
}
],
"comments": [{"content": "string",
"timestamp": "2019-08-24T14:15:22Z",
"commented_by": {"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
}
}
],
"labels": [{"id": 0,
"name": "string"
}
]
}

回答のメタデータを編集する

回答のメタデータを編集します。このエンドポイントでは、回答自体を編集することはできません。

Authorizations:

BearerAuth

path Parameters

answerId

required

integer <uint32>

Request Body schema: application/json
required

title

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

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

回答についているラベルの置き換え

Authorizations:

BearerAuth

path Parameters

answerId

required

integer <uint32>

Request Body schema: application/json
required

labels

required

Array of integers <uint32> [ items <uint32 > ]

Responses

Request samples

Payload

Content type

application/json

{"labels": [0
]
}

Response samples

400
401
403
500

Content type

application/json

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

フォームの回答につけられるラベルを作成する

Authorizations:

BearerAuth

Request Body schema: application/json
required

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

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

フォームの回答につけられるラベル一覧を取得する

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"id": 0,
"name": "string"
}
]

フォームの回答につけられるラベルを削除する

Authorizations:

BearerAuth

path Parameters

label_id

required

integer <uint32>

Responses

Response samples

400
401
403
404
500

Content type

application/json

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

フォームの回答につけられるラベルを更新する

Authorizations:

BearerAuth

path Parameters

label_id

required

integer <uint32>

Request Body schema: application/json
required

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

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

フォームにつけられるラベルを作成する

Authorizations:

BearerAuth

Request Body schema: application/json
required

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

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

フォームにつけられるラベル一覧を取得する

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"id": 0,
"name": "string"
}
]

フォームにつけられるラベルを削除する

Authorizations:

BearerAuth

path Parameters

form_label_id

required

integer <uint32>

Responses

Response samples

400
401
403
404
500

Content type

application/json

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

フォームにつけられるラベルを更新する

Authorizations:

BearerAuth

path Parameters

form_label_id

required

integer <uint32>

Request Body schema: application/json
required

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

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

PUBLICなフォームの一覧取得

このエンドポイントでは最小限のフォーム情報を含むリストが返されます。このエンドポイントからは visibility が PUBLIC であるフォームのみが取得されます。

また、取得パラメータとしてlimitとoffsetを指定し、取得件数を絞り込むことができます。レスポンス内容はid基準とし、昇順ソートしたものになります。

Authorizations:

BearerAuth

query Parameters

offset	integer <uint32> >= 0 取得件数の下限値例えば、offsetを1とすると2件目からのデータが取得できます。
limit	integer <uint32> >= 1 取得件数の上限値例えば、limitを10とすると10番目までのデータが取得できます。

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": 0,
"title": "string",
"description": "string",
"response_period": {"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z"
},
"answer_visibility": "PUBLIC"
}
]

質問の新規作成

Authorizations:

BearerAuth

Request Body schema: application/json
required

form_id required	integer <uint32>
required	Array of objects (Question)

Responses

Request samples

Payload

Content type

application/json

{"form_id": 0,
"questions": [{"id": 0,
"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}
]
}

Response samples

201
400
401
403
500

Content type

application/json

{"id": 0
}

質問の置き換え

Authorizations:

BearerAuth

Request Body schema: application/json
required

form_id required	integer <uint32>
required	Array of objects (Question)

Responses

Request samples

Payload

Content type

application/json

{"form_id": 0,
"questions": [{"id": 0,
"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}
]
}

Response samples

400
401
403
404
500

Content type

application/json

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

質問の削除

Authorizations:

BearerAuth

path Parameters

question_id

required

integer <uint32>

Responses

Response samples

400
401
403
404
500

Content type

application/json

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

フォームの詳細取得

Authorizations:

BearerAuth

path Parameters

formId

required

integer <uint32>

Responses

Response samples

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"settings": {"response_period": {"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z"
},
"webhook_url": "http://example.com",
"default_title": "string",
"visibility": "PUBLIC",
"answer_visibility": "PUBLIC"
},
"metadata": {"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"questions": [{"id": 0,
"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}
],
"labels": [{"id": 0,
"name": "string"
}
]
}

フォームの削除

Authorizations:

BearerAuth

path Parameters

formId

required

integer <uint32>

Responses

Response samples

400
401
403
404
500

Content type

application/json

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

フォームの値を更新する

フォームの設定値を変更するエンドポイント。

回答可能期間を設定する場合、has_response_periodをtrueに設定し、response_periodに期間を指定する必要があります。回答可能期間の設定を解除する場合、has_response_periodをfalseに設定します。

NOTE: has_response_periodの定義は、response_periodの設定を解除するためのものなのか、変更しないのかを判別するために定義したものであるため、より良い方法があればその定義に更新することを検討してもよいかも。

Authorizations:

BearerAuth

path Parameters

formId

required

integer <uint32>

Request Body schema: application/json
required

title	string
description	string
has_response_period	boolean
	object (ResponsePeriodUpdate)
webhook_url	string <uri>
default_title	string 各回答に対して自動でつけられるタイトルを設定します。 `$[question_id]`と指定することで、`question_id`の質問の回答をタイトルに含めることができます。
visibility	string (Visibility) Enum: "PUBLIC" "PRIVATE" PUBLIC: 全体公開 PRIVATE: 非公開
answer_visibility	string (Visibility) Enum: "PUBLIC" "PRIVATE" PUBLIC: 全体公開 PRIVATE: 非公開

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"has_response_period": true,
"response_period": {"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z"
},
"webhook_url": "http://example.com",
"default_title": "string",
"visibility": "PUBLIC",
"answer_visibility": "PUBLIC"
}

Response samples

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"settings": {"response_period": {"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z"
},
"webhook_url": "http://example.com",
"default_title": "string",
"visibility": "PUBLIC",
"answer_visibility": "PUBLIC"
},
"metadata": {"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"questions": [{"id": 0,
"title": "string",
"description": "string",
"question_type": "TEXT",
"choices": ["string"
],
"is_required": true
}
],
"labels": [{"id": 0,
"name": "string"
}
]
}

フォームの回答一覧取得

Authorizations:

BearerAuth

path Parameters

formId

required

integer <uint32>

Responses

Response samples

200
400
401
404
500

Content type

application/json

[{"id": 0,
"user": {"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
},
"form_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"title": "string",
"answers": [{"question_id": 0,
"answer": "string"
}
],
"comments": [{"content": "string",
"timestamp": "2019-08-24T14:15:22Z",
"commented_by": {"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
}
}
],
"labels": [{"id": 0,
"name": "string"
}
]
}
]

フォームの質問一覧取得

Authorizations:

BearerAuth

path Parameters

formId

required

integer <uint32>

Responses

Response samples

200
400
401
404
500

Content type

application/json

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

Users

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

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
}

ユーザー一覧の取得

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"uuid": "string",
"name": "string",
"role": "STANDARD_USER"
}
]

ユーザー情報を更新する

Authorizations:

BearerAuth

path Parameters

uuid

required

string

query Parameters

role

required

string (Role)

Enum: "STANDARD_USER" "ADMINISTRATOR"

Responses

Response samples

400
401
403
404
500

Content type

application/json

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

Sessions

セッションを開始する

Authorizations:

BearerAuth

Responses

Response samples

401
500

Content type

application/json

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

セッションを終了する

Authorizations:

BearerAuth

Responses

Response samples

401
500

Content type

application/json

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

seichi-portal-api-schema (0.0.0)

Forms

フォームの新規作成

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

フォームの一覧取得

Authorizations:

query Parameters

Responses

Response samples

回答の一覧取得

Authorizations:

Responses

Response samples

指定されたフォームに回答を追加する

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

回答にコメントを追加する

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

回答のコメントを更新する

Authorizations:

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/jsonrequired

Responses

Request samples

Response samples

回答についているラベルの置き換え

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

フォームの回答につけられるラベルを作成する

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/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required