API によるコンテンツパッケージの共有設定

  • 更新

Learn365では、Learn365 管理センターまたは Learn365 API を通じて、SCORMまたはAICCコンテンツパッケージの共有設定を構成することができます。

ここでは、Learn365 API を通じた、コンテンツパッケージの現在の共有設定の確認、コンテンツパッケージの共有設定に構成、または更新する方法について説明します。

 

共有設定を含むSCORMデータの取得する

現在の共有設定を含む SCORM コンテンツパッケージに関するデータの取得は、以下の手順に沿って行います。

1.https://api.365.systems/  にアクセスし、APIキーで認証します。

2.Scorms セクションに移動し、GET /odata/v2/Scorms Returns the list of Scorms  を選択し、右上の「Try it out」を選択します。

3.レスポンスに共有設定を含めるには、クエリオプションパラメータを設定します。

  • 「$expand」フィールドに「Sharing」と入力します。

レスポンスを絞り込む(特定のSCORMのみ返す)には「$filter」フィールドを設定します。

  • SCORM ID を使用する:「Id eq SCORM ID」と入力します。「SCORM ID」 は取得したIDに置き換えます。
    例:Id eq 2d1e1525-5c04-45d6-9c72-048333f2f6c1

  • SCORMのタイトルを使用する:「Title eq 'SCORM title'」と入力します。 「SCORM titleを該当するSCORMの名前に置き換えます。
    例:Title eq 'A Useful Guide to Appraisals'

 

Configure sharing settings of content packages1.png

 

4.「Execute」を選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Code の下の2xx(200など)は、リクエストが正しく動作したことを示します。
  • Response body には、テナントのコンテンツパッケージとその共有設定の情報が表示されます。 Ctrl+F で特定のコンテンツパッケージを検索できます。
  • フィルターを設定した場合、設定したパラメーターに一致するコンテンツパッケージの情報が含まれます。

 

Configure sharing settings of content packages2.png

 

6.この後で説明する「更新リクエスト」でに使用するため、当該するコンテンツパッケージのデータをすべてコピーするか、Downloadオプションを使用して、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存します。

 

共有設定を構成する

 

注記:

PUTメソッドは、コンテンツパッケージ全体を更新します。
そのため、コンテンツパッケージを部分的(例えば、共有設定だけなど)に更新する場合でも、コンテンツパッケージのすべての情報を入力する必要があります。

入力しなかった場合、省略したパラメータは上書きされ、コンテンツパッケージのデータから削除されます。

 

API を通じてコンテンツパッケージの共有設定では、特定のカタログやコースへの共有の追加や削除、テナントへの共有を構成することができます。

 

API を通じたコンテンツパッケージの共有設定の構成は、以下の手順に沿って行います。

1.Scorms セクションに移動し、PUT /odata/v2/Scorms({Id}) Updates a SCORM を選択し、右上の「Try it out」を選択します。

2.パラメータを入力します。

  • Id :「key: Id」フィールドに共有設定を更新するコンテンツパッケージの ID を入力します。(このパラメータは入力必須です。)

  • scorm  object:「Edit Value」フィールドに、前項の手順6 でコピー(保存)したレスポンス データを使用して、すべてのパラメータを入力します。

3. ”Sharing” の下で必要な共有設定を入力します。

  • "Id":このパラメータは任意(省略可)です。このIDはシステムによって自動的に生成されます。

  • "AccessType":このパラメータは必須です。アクセスタイプを「Read」「Edit」「FullControl」 のいずれかで指定します。 

  • "SharingType" :このパラメータは必須です。共有する領域を次のいずれかで指定します。

    • Courses:コンテンツパッケージは選択したコースと共有します
    • CourseCatalogs:コンテンツパッケージは選択したカタログと共有します
    • Tenant:コンテンツパッケージはテナントのすべてのカタログと共有します

  • "EntityId":このパラメータは必須です。"SharingType"で「Courses」または「CourseCatalogs」を指定した場合、関連するコースまたはカタログのIDに置き換えます。「Tenant」を指定した場合、文字列は null に置き換わります。

  • "EntityTitle":このパラメータは必須です。"SharingType"で「Courses」または「CourseCatalogs」を指定した場合、関連するコースまたはカタログのIDに置き換えます。「Tenant」を指定した場合、文字列は null に置き換わります。

以下で、コンテンツパッケージの共有設定を構成するリクエスト例を、いくつかご紹介します。

 

例1:共有しているカタログの1つを削除します。この場合、削除するカタログに関連するパラメータを ”Sharing” から削除してリクエストを実行します。

Before

"Sharing": [ {"Id": "53bebfe5-4e8d-4e11-8516-cedec2799f3d", "AccessType": "Read", "SharingType": "CourseCatalogs", "EntityId": "3b5cd8e8-d685-4ce5-9184-64847d07956c", "EntityTitle": "ACADEMY"},
{ "Id": "cc058bba-4692-4b62-80e9-e8fdba570fdd", "AccessType": "FullControl", "SharingType": "CourseCatalogs", "EntityId": "d4d0b82f-e67f-46d7-a142-fc347a520973", "EntityTitle": "My learning hub"}]

 

After 

"Sharing": { "Id": "cc058bba-4692-4b62-80e9-e8fdba570fdd", "AccessType": "FullControl", "SharingType": "CourseCatalogs", "EntityId": "d4d0b82f-e67f-46d7-a142-fc347a520973", "EntityTitle": "My learning hub" }

例2:コンテンツパッケージの共有設定にカタログを追加します。この場合、”Sharing” にこのカタログに関連するパラメータを追加し、リクエストを実行します。

Before

"Sharing": { "Id": "cc058bba-4692-4b62-80e9-e8fdba570fdd", "AccessType": "FullControl", "SharingType": "CourseCatalogs", "EntityId": "d4d0b82f-e67f-46d7-a142-fc347a520973", "EntityTitle": "My learning hub" }

 

After 

"Sharing": [ {"Id": "53bebfe5-4e8d-4e11-8516-cedec2799f3d", "AccessType": "Read", "SharingType": "CourseCatalogs", "EntityId": "3b5cd8e8-d685-4ce5-9184-64847d07956c", "EntityTitle": "ACADEMY"},
{ "Id": "cc058bba-4692-4b62-80e9-e8fdba570fdd", "AccessType": "FullControl", "SharingType": "CourseCatalogs", "EntityId": "d4d0b82f-e67f-46d7-a142-fc347a520973", "EntityTitle": "My learning hub"}]

例3:コースへの共有を追加します。この場合、”Sharing” にこのコースに関連するパラメータを追加し、リクエストを実行します。

Before

"Sharing": { "Id": "a45445b7-a2a2-470d-b864-bf2f08301374", "AccessType": "Edit", "SharingType": "Tenant", "EntityId": null, "EntityTitle": null }

 

After 

"Sharing": [ { "Id": "a45445b7-a2a2-470d-b864-bf2f08301374", "AccessType": "Edit", "SharingType": "Tenant", "EntityId": null, "EntityTitle": null }, { "Id": "350f60cc-2b7a-4a69-b99b-6dcad7d7d69e", "AccessType": "FullControl", "SharingType": "Courses", "EntityId": "065778c6-6d0c-45f0-b1de-7396952a8b2a", "EntityTitle": "Management skills" } ]

例4:テナント全体への共有を設定するには、関連するパラメータを追加してテナント全体のすべてのカタログへの共有を有効にするか、 現在のパラメータを削除して共有範囲をテナントカタログ全体に制限します。
以下の例では、コースに共有されたコンテンツパッケージに、テナント全体の共有を追加しています。

Before

"Sharing": { "Id": "350f60cc-2b7a-4a69-b99b-6dcad7d7d69e", "AccessType": "FullControl", "SharingType": "Courses", "EntityId": "065778c6-6d0c-45f0-b1de-7396952a8b2a", "EntityTitle": "Management skills" }

 

After 

"Sharing": [ { "Id": "a45445b7-a2a2-470d-b864-bf2f08301374", "AccessType": "Edit", "SharingType": "Tenant", "EntityId": null, "EntityTitle": null }, { "Id": "350f60cc-2b7a-4a69-b99b-6dcad7d7d69e", "AccessType": "FullControl", "SharingType": "Courses", "EntityId": "065778c6-6d0c-45f0-b1de-7396952a8b2a", "EntityTitle": "Management skills" } ]

 

4.「Execute」を選択してリクエストを実行します。

下記に示すのはコンテンツパッケージの共有設定を更新するリクエストの例です。
このリクエストには、特定のコースと2つのカタログへのコンテンツパッケージの共有が含まれています。

{
"Id": "6bfa1fe2-f3ad-4116-8b19-cad3c4b5b819",
"Title": "Code of Conduct",
"Description": "This content package provides guidelines about the company's policies for employee conduct.",
"Configuration": "{\"AllowBrowse\":false,\"AllowReview\":false,\"AllowContinueIfCompletionStatusEqualsNo\":true,

\"ControlModeFlow\":true,\"ShowStatisticsForLearner\":false,\"NavOptions\":0,

\"ShowCompletionStatus\":false,\"FinishByLessonStatus\":true,\"RedirectIfCompleted\":true,

\"AutoContinue\":true,\"CompleteAsPassed\":false,\"Tag\":\"\",\"TocWidth\":null,\"AsyncCommit\":false,

\"Attempts\":null,\"Timeout\":null,\"NewWindow\":false,\"DlgWidth\":null,\"DlgHeight\":null,

\"AllowResizing\":false,\"MinimalWidth\":null,\"MinimalHeight\":null}",
"Version": 0,
"ContentType": "Scorm",
"Location": "9d087e7bc31c440cb976ad8a54c3863a",
"FileName": "employee-conduct-scorm12-l1x6ufa-.zip",
"CreatedAt": "2022-06-17T08:44:41.667Z",
"ModifiedAt": "2022-10-20T11:05:56.523Z",
"Sharing": [
{
"Id": "72fa2368-08cb-4fe9-baad-fc40d1a8da8e",
"AccessType": "Read",
"SharingType": "CourseCatalogs",
"EntityId": "3b92a150-b439-4d85-ab9b-10174fe93ae6",
"EntityTitle": "Customer care and service training"
},
{
"Id": "2f207cbc-5ea5-4f3b-954f-33d70a28a85e",
"AccessType": "Read",
"SharingType": "CourseCatalogs",
"EntityId": "d4d0b82f-e67f-46d7-a142-fc347a520973",
"EntityTitle": "My learning hub"
},
{
"Id": "c4c0afb2-0d3f-40dc-b037-aeec0aeeab54",
"AccessType": "FullControl",
"SharingType": "Courses",
"EntityId": "a89d5cc6-91da-4640-b213-f35efc9a219d",
"EntityTitle": "Code of Conduct"
}
]

Configure sharing settings of content packages3.png

 

5.Responses ブロックで結果を確認します。

  • Code の下の2xx(201など)は、リクエストが正しく動作したことを示します。
  • Response body には、更新された共有設定を含むコンテンツパッケージのデータが表示されます。
  • Learn365 管理センター>コンテンツ>コンテンツパッケージストレージで、該当のコンテンツパッケージの編集から、結果を確認できます。