DataFlex

SharePoint -- Create List

See more SharePoint Examples

This example shows how to create a new SharePoint list. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoHttp
    Variant vReq
    Handle hoReq
    Handle hoJson
    Boolean iBUseTls
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Integer iTemp2

    Move False To iSuccess

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

    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

    // To create a list, we're going to POST to
    // https://SHAREPOINT_HTTPS_DOMAIN/_api/web/lists
    // with a request body containing the following JSON:
    // 
    // {
    //   "__metadata": {
    //     "type": "SP.List"
    //   },
    //   "AllowContentTypes": true,
    //   "BaseTemplate": 100,
    //  "ContentTypesEnabled": true,
    //  "Description": "My list description",
    //  "Title": "Test"
    // }

    // This example will create a folder named ChilkatTest in /Documents

    Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
    If (Not(IsComObjectCreated(hoReq))) Begin
        Send CreateComObject of hoReq
    End
    Set ComHttpVerb Of hoReq To "POST"
    Set ComPath Of hoReq To "/_api/web/lists"

    // We need to add a form digest value in the X-RequestDigest header field.
    // See this example for details on
    // how to get (and cache) a form digest value
    Send ComAddHeader To hoReq "X-RequestDigest" "SHAREPOINT_FORM_DIGEST"

    // Set the Content-Type, and indicate that a JSON response is desired.
    Set ComContentType Of hoReq To "application/json;odata=verbose"
    Send ComAddHeader To hoReq "Accept" "application/json;odata=verbose"

    // Create and add the JSON body.
    // Use this online tool to generate code from sample JSON: 
    // Generate Code to Create JSON
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "__metadata.type" "SP.List" To iSuccess
    Get ComUpdateBool Of hoJson "AllowContentTypes" True To iSuccess
    Get ComUpdateInt Of hoJson "BaseTemplate" 100 To iSuccess
    Get ComUpdateBool Of hoJson "ContentTypesEnabled" True To iSuccess
    Get ComUpdateString Of hoJson "Description" "My list description" To iSuccess
    Get ComUpdateString Of hoJson "Title" "Test" To iSuccess

    // Send the POST using HTTPS (TLS). Port 443 is the default port for https.
    Move True To iBUseTls
    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoReq to vReq
    Get pvComObject of hoResp to vResp
    Get ComHttpSReq Of hoHttp "SHAREPOINT_HTTPS_DOMAIN" 443 iBUseTls vReq vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The response body contains JSON.
    Get ComBodyStr Of hoResp To sTemp1
    Get ComLoad Of hoJson sTemp1 To iSuccess
    Set ComEmitCompact Of hoJson To False

    // The expected success response code is 201.
    // (Let's also check for 200, just in case things change..)
    Get ComStatusCode Of hoResp To iTemp1
    Get ComStatusCode Of hoResp To iTemp2
    If ((iTemp1 <> 200) And (iTemp2 <> 201)) Begin
        Get ComStatusCode Of hoResp To iTemp1
        Showln "Response status code = " iTemp1
        Get ComEmit Of hoJson To sTemp1
        Showln sTemp1
        Showln "Failed"
        Procedure_Return
    End

    // Show the successful JSON response.
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1
    Showln "Success."

    // Use this online tool to generate parsing code from sample JSON: 
    // Generate Parsing Code from JSON


End_Procedure