eden APIドキュメント (0.1.8)

Download OpenAPI specification:Download

edenを外部サービスと連携させるためのAPI仕様についてのドキュメントです。(現在ベータ版のため、今後仕様が変更される可能性が高いことをご了承ください)

Authentication

ApiKeyAuth

「token accesskey secretkey」の形式

Security Scheme Type API Key
Header parameter name: Authorization

指定したコースの終了率一覧を取得します

指定したコースの終了率一覧を取得します

Authorizations:
path Parameters
courseid
required
integer

コースID

query Parameters
usergroupids
Array of strings

対象となるユーザーグループID(カンマ区切りの整数)

min_point
integer

取得する終了率の下限

max_point
integer

取得する終了率の上限

offset
integer
Default: 0

取得する件数の開始点

count
integer
Default: 100

取得する件数(最大200、全件取得する場合は-1)

include_fullpath
string
Default: false
Enum: "true" "false" "default"

ユーザーフォルダとユーザーグループフォルダの名前をフルパスで取得するかどうか。defaultの場合はシステム設定に従う。

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "results": [
    ]
}

コースを割り当てられている対象ユーザーグループ一覧を取得する

コースを割り当てられている対象ユーザーグループ一覧を取得する

Authorizations:
path Parameters
courseid
required
integer

コースID

Responses

Response samples

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

コースを割り当てられているコンテンツ一覧を取得する

コースを割り当てられているコンテンツ一覧を取得する

Authorizations:
path Parameters
courseid
required
integer

コースID

Responses

Response samples

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