Unicode C
Unicode C
SharePoint List Document Libraries
See more SharePoint Examples
This example shows how to use Chilkat's HttpCurl class to list the document libraries in a SharePoint site. In Microsoft Graph, SharePoint document libraries are represented as drives. The example demonstrates how HttpCurl can automatically resolve a SharePoint site name to its Microsoft Graph site ID, then use that ID to retrieve and display the site's document libraries.
Chilkat Unicode C Downloads
#include <C_CkJsonObjectW.h>
#include <C_CkHttpCurlW.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObjectW jsonAuth;
HCkHttpCurlW curl;
const wchar_t *curlCommand;
int statusCode;
HCkJsonObjectW json;
int i;
int numDrives;
success = FALSE;
// This example retrieves the document libraries for a SharePoint site.
//
// In Microsoft Graph terminology, a document library is represented as a "drive".
// The example demonstrates how HttpCurl can automatically resolve a SharePoint
// site name to a site ID before requesting the site's document libraries.
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.
jsonAuth = CkJsonObjectW_Create();
// 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
CkJsonObjectW_putEnableSecrets(jsonAuth,TRUE);
success = CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.client_id",L"!!sharepoint|oauth2|client_id");
if (success == TRUE) {
success = CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.client_secret",L"!!sharepoint|oauth2|client_secret");
}
if (success == TRUE) {
success = CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.token_endpoint",L"!!sharepoint|oauth2|token_endpoint");
}
if (success == FALSE) {
wprintf(L"%s\n",CkJsonObjectW_lastErrorText(jsonAuth));
CkJsonObjectW_Dispose(jsonAuth);
return;
}
// Request Microsoft Graph permissions that were granted to the application.
CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.scope",L"https://graph.microsoft.com/.default");
// ---------------------------------------------------------------------------------------------------
curl = CkHttpCurlW_Create();
// 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.
CkHttpCurlW_SetAuth(curl,jsonAuth);
// Define variables whose values are already known.
//
// These variables are referenced in the curl command using
// {{variable_name}} substitution syntax.
CkHttpCurlW_SetVar(curl,L"sharepoint_hostname",L"example.sharepoint.com");
CkHttpCurlW_SetVar(curl,L"site_name",L"test");
// The document libraries endpoint requires a Microsoft Graph site ID.
//
// Because the application only knows the SharePoint site name,
// HttpCurl must first retrieve the corresponding site ID.
//
// Define a function that can resolve the site_id variable when needed.
// HttpCurl may execute this function automatically if it determines that
// site_id is required by another request.
CkHttpCurlW_AddFunction(curl,L"getSite",L"GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}");
// Extract the "id" field from the getSite response and store it
// in the HttpCurl variable named "site_id".
//
// Any later request that references {{site_id}} can use this value.
CkHttpCurlW_AddOutput(curl,L"getSite",L"id",L"site_id");
// The target Microsoft Graph request:
//
// curl -X GET \"https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives
//
// This request returns the document libraries belonging to the site.
//
// Microsoft Graph refers to document libraries as "drives",
// so each object in the response represents one document library.
//
// No Authorization header is included because HttpCurl automatically
// adds it when OAuth2 authentication is configured.
curlCommand = L"curl -X GET \"https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives\"";
// Execute the request.
//
// HttpCurl examines the target curl command and determines that
// the variable {{site_id}} is required.
//
// Because site_id is not yet known, HttpCurl searches for a function
// capable of producing it. The getSite function provides the "id"
// output, which is mapped to the site_id variable.
//
// The execution plan becomes:
//
// 1) Execute getSite to obtain site_id.
// 2) Substitute {{site_id}} into the target request.
// 3) Execute the drives request.
//
// The final HTTP response returned by DoYourThing is always the
// response from the target curl command, which is the last step in the plan.
success = CkHttpCurlW_DoYourThing(curl,curlCommand);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpCurlW_lastErrorText(curl));
CkJsonObjectW_Dispose(jsonAuth);
CkHttpCurlW_Dispose(curl);
return;
}
// A successful Graph response should return HTTP 200.
// Any other status code typically indicates an authentication,
// permission, or resource lookup error.
statusCode = CkHttpCurlW_getStatusCode(curl);
if (statusCode != 200) {
wprintf(L"%s\n",CkHttpCurlW_responseBodyStr(curl));
wprintf(L"status code = %d\n",statusCode);
CkJsonObjectW_Dispose(jsonAuth);
CkHttpCurlW_Dispose(curl);
return;
}
// The response body contains a JSON array named "value".
// Each element of the array describes a SharePoint document library.
json = CkJsonObjectW_Create();
CkJsonObjectW_putEmitCompact(json,FALSE);
CkHttpCurlW_GetResponseJson(curl,json);
wprintf(L"%s\n",CkJsonObjectW_emit(json));
// Iterate over the document libraries returned by Microsoft Graph
// and display selected properties for each library.
i = 0;
numDrives = CkJsonObjectW_SizeOfArray(json,L"value");
while (i < numDrives) {
CkJsonObjectW_putI(json,i);
wprintf(L"name: %s\n",CkJsonObjectW_stringOf(json,L"value[i].name"));
wprintf(L"description: %s\n",CkJsonObjectW_stringOf(json,L"value[i].description"));
wprintf(L"id: %s\n",CkJsonObjectW_stringOf(json,L"value[i].id"));
wprintf(L"webUrl: %s\n",CkJsonObjectW_stringOf(json,L"value[i].webUrl"));
wprintf(L"displayName: %s\n",CkJsonObjectW_stringOf(json,L"value[i].createdBy.user.displayName"));
wprintf(L"-\n");
i = i + 1;
}
wprintf(L"Success.\n");
CkJsonObjectW_Dispose(jsonAuth);
CkHttpCurlW_Dispose(curl);
CkJsonObjectW_Dispose(json);
}