DataFlex

SharePoint -- Get Folder Properties

See more SharePoint Examples

This example shows how to get the properties of a SharePoint folder. Specifically, it gets the properties of one of our test folders named "Briefing 02032017". DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoHttp
    Variant vSbJson
    Handle hoSbJson
    Handle hoJson
    Integer iItemCount
    String sTemp1

    Move False To iSuccess

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

    // -------------------------------------------------------------------------
    // The following comments apply to SharePoint Windows classic authentication.
    // -------------------------------------------------------------------------
    // For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
    // The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
    // The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
    // Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
    // for example, "chilkat" instead of "chilkat@mycompany.com"

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // If SharePoint Windows classic authentication is used, then set the 
    // Login, Password, LoginDomain, and NtlmAuth properties.
    Set ComLogin Of hoHttp To "SHAREPOINT_USERNAME"
    Set ComPassword Of hoHttp To "SHAREPOINT_PASSWORD"
    Set ComLoginDomain Of hoHttp To "SHAREPOINT_NTLM_DOMAIN"
    Set ComNtlmAuth Of hoHttp To 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
    Set ComAccept Of hoHttp To "application/json;odata=verbose"
    Set ComAcceptCharset Of hoHttp To "utf-8"

    // If your Sharepoint site is within a site collection, then use "https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Briefing 02032017')" where "teamA" is the name of the site.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJson
    If (Not(IsComObjectCreated(hoSbJson))) Begin
        Send CreateComObject of hoSbJson
    End
    Get pvComObject of hoSbJson to vSbJson
    Get ComQuickGetSb Of hoHttp "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Briefing 02032017')" vSbJson To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get pvComObject of hoSbJson to vSbJson
    Get ComLoadSb Of hoJson vSbJson To iSuccess
    Set ComEmitCompact Of hoJson To False

    // To get the number of items in the folder:
    Get ComIntOf Of hoJson "d.ItemCount" To iItemCount
    Showln "Number of items: " iItemCount

    // The full JSON response looks like the following:
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1

    // { 
    //   "d": { 
    //     "__metadata": { 
    //       "id": "Web/GetFolderByServerRelativeUrl('/Briefing 02032017')",
    //       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')",
    //       "type": "SP.Folder"
    //     },
    //     "Files": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Files"
    //       }
    //     },
    //     "ListItemAllFields": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/ListItemAllFields"
    //       }
    //     },
    //     "ParentFolder": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/ParentFolder"
    //       }
    //     },
    //     "Properties": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Properties"
    //       }
    //     },
    //     "Folders": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Folders"
    //       }
    //     },
    //     "ItemCount": 9,
    //     "Name": "Briefing 02032017",
    //     "ServerRelativeUrl": "/Briefing 02032017",
    //     "WelcomePage": ""
    //   }
    // }
    // 


End_Procedure