educationSynchronizationProfile: uploadUrl

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Retrieve a shared access signature (SAS) for uploading source files to Azure blob storage for a specific school data synchronization profile in the tenant. The SAS token has a validity of one hour.

The upload URL is provided only for the CSV data provider.

Note: To access the blob storage with the SAS token, use the Azure storage SDKs or AzCopy.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions
Delegated (work or school account) EduAdministration.ReadWrite
Delegated (personal Microsoft account Not supported.
Application EduAdministration.ReadWrite.All

HTTP request

GET /education/synchronizationProfiles/{id}/uploadUrl

Request headers

Name Type Description
Authorization string Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a SAS URL for the educationSynchronizationProfile in the response body.

If a previous request is still being processed, this method returns a 409 Conflict indicating that the upload is presently blocked for the educationSynchronizationProfile.

Example

Request

The following is an example of the request.

GET https://graph.microsoft.com/beta/education/synchronizationProfiles/{id}/uploadUrl
Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#String",
    "value": "https://sdsstorage.blob.core.windows.net/86904b1e-c7d0-4ead-b13a-98f11fc400ee?sv=2015-07-08&sr=c&si=SharedAccessPolicy_20170704044441&sig=CH65vxxqXETCkQNH0Lfsu31cUo0s0XcEEo0OE2YiL6Q%3D&se=2017-07-04T08%3A43%3A01Z&sp=w"
}