Zig

Upload a File to a SharePoint Documents Library using HttpCurl

See more SharePoint Examples

This example shows how to use Chilkat's HttpCurl class to upload a local file to the root of a SharePoint Documents document library. The example uses Microsoft Graph to automatically resolve the SharePoint site name to a site ID, find the drive ID for the Documents library, and then upload helloChilkat.txt so it is stored in SharePoint as example.txt. A successful upload returns 201 Created when a new file is created, or 200 OK when an existing file is updated or replaced.

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    var success: bool = false;

    // This example uploads a local file to the root of a SharePoint
    // Documents document library.
    //
    // The local file:
    //
    //   qa_data/helloChilkat.txt
    //
    // is uploaded and stored in SharePoint as:
    //
    //   example.txt
    //
    // The example demonstrates how HttpCurl automatically resolves:
    //
    //   site_name  -> site_id
    //   site_id    -> document_library_id
    //
    // and then uploads the file to the target document library using
    // the Microsoft Graph file upload API.

    success = false;

    // --------------------------------------------------------------------------------------------------------
    // Before running this example, create an Azure App Registration and grant it
    // the Microsoft Graph permissions required to access SharePoint.
    //
    // The application will authenticate using OAuth2 Client Credentials.
    // See:
    // How to Create SharePoint App Registration for OAuth 2.0 Client Credentials
    // --------------------------------------------------------------------------------------------------------

    // Build a JSON authentication configuration.
    // HttpCurl will use this information to automatically obtain OAuth2 access tokens.
    const json_auth = try chilkat.JsonObject.init();
    defer json_auth.deinit();

    // Enable secret lookup.
    //
    // Instead of hard-coding sensitive values such as the client ID,
    // client secret, and token endpoint, secret specification strings
    // are used.  Chilkat automatically retrieves the actual values from
    // Windows Credential Manager (Windows) or Apple Keychain (macOS).
    //
    // See:
    // Secret Specification Strings
    json_auth.setEnableSecrets(true);

    success = if (json_auth.updateString("oauth2.client_id", "!!sharepoint|oauth2|client_id")) true else |_| false;
    if (success) {
        success = if (json_auth.updateString("oauth2.client_secret", "!!sharepoint|oauth2|client_secret")) true else |_| false;
    }

    if (success) {
        success = if (json_auth.updateString("oauth2.token_endpoint", "!!sharepoint|oauth2|token_endpoint")) true else |_| false;
    }

    if (!success) {
        std.debug.print("{s}\n", .{try json_auth.getLastErrorText(alloc)});
        return;
    }

    // Request Microsoft Graph permissions that were granted to the application.
    json_auth.updateString("oauth2.scope", "https://graph.microsoft.com/.default") catch {};

    // ---------------------------------------------------------------------------------------------------

    const curl = try chilkat.HttpCurl.init();
    defer curl.deinit();

    // Associate the OAuth2 configuration with HttpCurl.
    //
    // When the request is executed, Chilkat automatically obtains an access token
    // if needed and adds the Authorization: Bearer header to the HTTP request.
    curl.setAuth(json_auth) catch {};

    // Define values that are already known.
    //
    // These variables are referenced in curl commands using
    // {{variable_name}} substitution syntax.
    curl.setVar("sharepoint_hostname", "example.sharepoint.com");
    curl.setVar("site_name", "test");

    // The upload request requires a Microsoft Graph site ID.
    //
    // Because the application only knows the SharePoint site name,
    // define a helper function that can retrieve the site information.
    curl.addFunction("getSite", "GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}") catch {};

    // Extract the site's ID and store it in the HttpCurl variable named site_id.
    curl.addOutput("getSite", "id", "site_id") catch {};

    // The upload request also requires the drive ID of the Documents
    // document library.
    //
    // Microsoft Graph refers to document libraries as "drives".
    curl.addFunction("getDrives", "GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives") catch {};

    // Search the returned drives for the one named "Documents"
    // and save its drive ID in the document_library_id variable.
    curl.addOutput2("getDrives", "value", "name", "Documents", true, "id", "document_library_id") catch {};

    // This is the target Microsoft Graph request.
    //
    // PUT /drives/{drive-id}/root:/{filename}:/content
    //
    // This endpoint uploads a file to a document library.  If the target
    // file already exists, Microsoft Graph replaces the existing content.
    // If the file does not exist, a new file is created.
    //
    // The --data-binary option uploads the contents of the local file
    // exactly as stored on disk.
    //
    // The uploaded file will be named "example.txt" in the root of the
    // Documents document library.
    const curl_command = "curl -X PUT -H \"Content-Type: text/plain; charset=utf-8\" --data-binary @qa_data/helloChilkat.txt \"https://graph.microsoft.com/v1.0/drives/{{document_library_id}}/root:/example.txt:/content\"";

    // Execute the request.
    //
    // HttpCurl examines the target request and determines that
    // document_library_id is required.
    //
    // To obtain this value, it automatically builds and executes
    // the following dependency chain:
    //
    //   1) getSite    -> site_id
    //   2) getDrives  -> document_library_id
    //   3) upload     -> example.txt
    //
    // The final response returned by DoYourThing is the response
    // from the upload request.
    curl.doYourThing(curl_command) catch {
        std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
        return;
    };

    // A successful upload can return:
    //
    //   201 (Created)
    //       A new file was created.
    //
    //   200 (OK)
    //       An existing file was updated or replaced.
    //
    // Any other status code typically indicates an authentication,
    // permission, site lookup, document library lookup, or upload error.
    const status_code = curl.getStatusCode();
    if ((status_code != 201) and (status_code != 200)) {
        std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
        std.debug.print("status code = {d}\n", .{status_code});
        return;
    }

    // The file has been uploaded successfully and is now available
    // in the root of the Documents document library as:
    //
    //   example.txt
    //
    std.debug.print("Success.\n", .{});
}