(PureBasic) SharePoint -- Create List

See more SharePoint Examples

This example shows how to create a new SharePoint list.

For more information, see https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; If SharePoint Windows classic authentication is used, then set the 
    ; Login, Password, LoginDomain, and NtlmAuth properties.
    CkHttp::setCkLogin(http, "SHAREPOINT_USERNAME")
    CkHttp::setCkPassword(http, "SHAREPOINT_PASSWORD")
    CkHttp::setCkLoginDomain(http, "SHAREPOINT_NTLM_DOMAIN")
    CkHttp::setCkNtlmAuth(http, 1)

    ; 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

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/_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
    CkHttpRequest::ckAddHeader(req,"X-RequestDigest","SHAREPOINT_FORM_DIGEST")

    ; Set the Content-Type, and indicate that a JSON response is desired.
    CkHttpRequest::setCkContentType(req, "application/json;odata=verbose")
    CkHttpRequest::ckAddHeader(req,"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
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"__metadata.type","SP.List")
    CkJsonObject::ckUpdateBool(json,"AllowContentTypes",1)
    CkJsonObject::ckUpdateInt(json,"BaseTemplate",100)
    CkJsonObject::ckUpdateBool(json,"ContentTypesEnabled",1)
    CkJsonObject::ckUpdateString(json,"Description","My list description")
    CkJsonObject::ckUpdateString(json,"Title","Test")

    ; Send the POST using HTTPS (TLS). Port 443 is the default port for https.
    bUseTls.i = 1
    resp.i = CkHttp::ckSynchronousRequest(http,"SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; The response body contains JSON.
    CkJsonObject::ckLoad(json,CkHttpResponse::ckBodyStr(resp))
    CkJsonObject::setCkEmitCompact(json, 0)

    ; The expected success response code is 201.
    ; (Let's also check for 200, just in case things change..)
    If (CkHttpResponse::ckStatusCode(resp) <> 200) AND (CkHttpResponse::ckStatusCode(resp) <> 201)
        Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed"
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Show the successful JSON response.
    Debug CkJsonObject::ckEmit(json)
    Debug "Success."

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


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure