Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Node.js Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Node.js) SharePoint -- Get File Property

See more SharePoint Examples

Demonstrates how to get a specific property of a SharePoint file. Any of the following properties can be retrieved:

  • Author: Gets a value that specifies the user who added the file.
  • CheckedOutByUser: Gets a value that returns the user who has checked out the file.
  • CheckInComment: Gets a value that returns the comment used when a document is checked in to a document library.
  • CheckOutType: Gets a value that indicates how the file is checked out of a document library. Represents an
  • ContentTag: Returns internal version of content, used to validate document equality for read purposes.
  • CustomizedPageStatus: Gets a value that specifies the customization status of the file. Represents an
  • ETag: Gets a value that specifies the ETag value.
  • Exists: Gets a value that specifies whether the file exists.
  • Length: Gets the size of the file in bytes, excluding the size of any Web Parts that are used in the file.
  • Level: Gets a value that specifies the publishing level of the file. Represents an
  • ListItemAllFields: Gets a value that specifies the list item field values for the list item corresponding to the file.
  • LockedByUser: Gets a value that returns the user that owns the current lock on the file.
  • MajorVersion: Gets a value that specifies the major version of the file.
  • MinorVersion: Gets a value that specifies the minor version of the file.
  • ModifiedBy: Gets a value that returns the user who last modified the file.
  • Name: Gets the name of the file including the extension.
  • ServerRelativeUrl: Gets the relative URL of the file based on the URL for the server.
  • TimeCreated: Gets a value that specifies when the file was created.
  • TimeLastModified: Gets a value that specifies when the file was last modified.
  • Title: Gets a value that specifies the display name of the file.
  • UiVersion: Gets a value that specifies the implementation-specific version identifier of the file.
  • UiVersionLabel: Gets a value that specifies the implementation-specific version identifier of the file.
  • Versions: Gets a value that returns a collection of file version objects that represent the versions of the file.

Install Chilkat for Node.js and Electron using npm at

Chilkat npm packages for Node.js

Chilkat npm packages for Electron

on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();

    // If SharePoint Windows classic authentication is used, then set the 
    // Login, Password, LoginDomain, and NtlmAuth properties.
    http.Login = "SHAREPOINT_USERNAME";
    http.Password = "SHAREPOINT_PASSWORD";
    http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN";
    http.NtlmAuth = true;

    // The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
    // If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
    // establish the cookie as shown at SharePoint Online Authentication

    // Indicate that we want a JSON reply
    http.Accept = "application/json;odata=verbose";
    http.AcceptCharset = "utf-8";

    // Get the Author property.
    var url = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Author";

    var jsonReply = http.QuickGetStr(url);
    if (http.LastMethodSuccess !== true) {
        console.log(http.LastErrorText);
        return;
    }

    var json = new chilkat.JsonObject();
    json.Load(jsonReply);
    json.EmitCompact = false;

    // Make sure it was a success response, and that we really have metadata.
    // If it was an error response, then the JSON is error information..
    if (http.LastStatus !== 200) {
        console.log(json.Emit());
        console.log("Failed.");
        return;
    }

    console.log(json.Emit());

    // The Author property returns JSON looking like this:

    // {
    //   "d": {
    //     "__metadata": {
    //       "id": "Web/GetUserById(18)",
    //       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetUserById(18)",
    //       "type": "SP.User"
    //     },
    //     "Groups": {
    //       "__deferred": {
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetUserById(18)/Groups"
    //       }
    //     },
    //     "Id": 18,
    //     "IsHiddenInUI": false,
    //     "LoginName": "i:0#.w|mydomain\\msmith",
    //     "Title": "Mike Smith",
    //     "PrincipalType": 1,
    //     "Email": "msmith@mydomain.com",
    //     "IsSiteAdmin": false,
    //     "UserId": {
    //       "__metadata": {
    //         "type": "SP.UserIdInfo"
    //       },
    //       "NameId": "s-1-5-21-3433503314-2897774614-343593928-1137",
    //       "NameIdIssuer": "urn:office:idp:activedirectory"
    //     }
    //   }
    // }
    // 

    // Get the Title and Email:
    console.log("----");
    console.log("Title: " + json.StringOf("d.Title"));
    console.log("Email: " + json.StringOf("d.Email"));
    console.log("----");

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

    // Get the Versions property.
    url = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Versions";

    jsonReply = http.QuickGetStr(url);
    if (http.LastMethodSuccess !== true) {
        console.log(http.LastErrorText);
        return;
    }

    json.Load(jsonReply);
    console.log(json.Emit());

    // The Versions JSON reply looks like this:

    // {
    //   "d": {
    //     "results": [
    //       {
    //         "__metadata": {
    //           "id": "a8d025e2-8255-4487-9edb-9e796ab2889c",
    //           "type": "SP.FileVersion"
    //         },
    //         "CreatedBy": {
    //           "__deferred": {
    //             "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/CreatedBy"
    //           }
    //         },
    //         "CheckInComment": "",
    //         "Created": "2016-03-15T02:22:26Z",
    //         "ID": 1,
    //         "IsCurrentVersion": false,
    //         "Size": 21082,
    //         "Url": "_vti_history/1/Documents/VCAC-document.docx",
    //         "VersionLabel": "0.1"
    //       },
    //       {
    //         "__metadata": {
    //           "id": "8ab3eadd-9126-4f65-a2a3-3b0689c592d6",
    //           "type": "SP.FileVersion"
    //         },
    //         "CreatedBy": {
    //           "__deferred": {
    //             "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/CreatedBy"
    //           }
    //         },
    //         "CheckInComment": "",
    //         "Created": "2016-03-15T05:28:24Z",
    //         "ID": 2,
    //         "IsCurrentVersion": false,
    //         "Size": 21082,
    //         "Url": "_vti_history/2/Documents/VCAC-document.docx",
    //         "VersionLabel": "0.2"
    //       }
    //     ]
    //   }
    // }
    // 

    // Get each VersionLabel, Size, and Url...
    var numVersions = json.SizeOfArray("d.results");
    var i = 0;
    while (i < numVersions) {
        json.I = i;
        console.log("---- i = " + i);
        console.log("VersionLabel: " + json.StringOf("d.results[i].VersionLabel"));
        console.log("Url: " + json.StringOf("d.results[i].Url"));
        console.log("Size: " + json.IntOf("d.results[i].Size"));
        i = i+1;
    }

    // The output is:

    // ---- i = 0
    // VersionLabel: 0.1
    // Url: _vti_history/1/Documents/VCAC-document.docx
    // Size: 21082
    // ---- i = 1
    // VersionLabel: 0.2
    // Url: _vti_history/2/Documents/VCAC-document.docx
    // Size: 21082

}

chilkatExample();

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.