educationSynchronizationProfile にファイルをアップロードした後で同期を開始する

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

テナント内の特定の学校データ同期プロファイルに アップロードされたファイル を確認します。 検証が成功すると、プロファイルで同期が開始されます。 それ以外の場合、応答にはエラーと警告が含まれています。 応答にエラーが含まれている場合、同期は開始されません。 応答に警告だけが含まれている場合は、同期が開始されます。

注: データ プロバイダーが educationcsvdataprovider 型の場合にのみ、このメソッドを使用します。 また、プロファイルを開始する前に、プロファイルの state プロパティをプロビジョニングする必要があります。 プロファイル オブジェクトをポーリングして、その状態プロパティを確認します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可
委任 (職場または学校のアカウント) EduAdministration.ReadWrite
委任 (個人用 Microsoft アカウント) サポートされていません。
Application EduAdministration.ReadWrite.All

HTTP 要求

POST /education/synchronizationProfiles/{id}/start

要求ヘッダー

名前 種類 説明
Authorization string ベアラー {token}。必須。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードを返します。 失敗した場合は、 を返します 400 Bad Request。 応答には、エラーまたは警告が見つかった場合、応答本文の一部として educationFileSynchronizationVerificationMessage オブジェクトのコレクションが含まれます。

要求

以下は、要求の例です。

POST https://graph.microsoft.com/beta/education/synchronizationProfiles/{id}/start
応答

以下は、応答の例です。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/Collection(microsoft.graph.verificationMessage)",
    "value": [
        {
            "type": "Error",
            "fileName": "section.csv",
            "description": "5 row(s) have missing data for the field - SIS ID"
        },
        {
            "type": "Error",
            "fileName": "section.csv",
            "description": "5 row(s) have an invalid format for the field - SIS ID"
        },
        {
            "type": "Warning",
            "fileName": "student.csv",
            "description": "3 duplicates found in column SIS ID which requires values to be Unique."
        },
        {
            "type": "Warning",
            "fileName": "student.csv",
            "description": "3 duplicates found in column Username which requires values to be Unique."
        },
        {
            "type": "Error",
            "fileName": "studentenrollment.csv",
            "description": "125 row(s) have referenced data not found in source. Field - Section SIS ID"
        },
        {
            "type": "Error",
            "fileName": "studentenrollment.csv",
            "description": "35 row(s) have referenced data not found in source. Field - SIS ID"
        },
        {
            "type": "Warning",
            "fileName": "teacher.csv",
            "description": "3 duplicates found in column SIS ID which requires values to be Unique."
        },
        {
            "type": "Warning",
            "fileName": "teacher.csv",
            "description": "3 duplicates found in column Username which requires values to be Unique."
        },
        {
            "type": "Error",
            "fileName": "teacherroster.csv",
            "description": "10 row(s) have referenced data not found in source. Field - Section SIS ID"
        },
        {
            "type": "Error",
            "fileName": "teacherroster.csv",
            "description": "91 row(s) have referenced data not found in source. Field - SIS ID"
        }
    ]
}