SharePoint Online - Working With List Content Types Using PowerShell

In this article, we will discuss the configuration of some of the important operations on Content Type for SharePoint Online Lists. Though I have taken only a handful of operations to showcase in this demo, remember there are a lot more to explore.

Operation - How to enable “Content Types” for List

We can see this setting available under “Advanced Settings” for the list as shown below,

We can play with this setting using PowerShell as described below,

In Step 1 we will get the object reference to the respective list by calling “GetByTitle” method.

In Step 2 we will set “ContentTypesEnabled” to True.

In Step 3 we will update the listed property by calling “Update” method.

In Step 4 we will send the batch request to SharePoint Server for processing by calling “ExecuteQuery” method.

In Step 5 we will display a success message to the Users if Step 4 executes successfully.

In Step 6 we will call the function that we have explained in Step 1-5.

Once this script executes successfully we can see list setting updated by navigating to “Advanced Settings” of the list as shown below,

Operation - How to “Add Existing Content Type To List”

We can see this setting available under “List Settings” for the list as shown below,

We can play with this setting using PowerShell as described below,

In Step 1 we will get the object reference to the respective Web.

In Step 2 we will get the object reference to the respective list by calling “GetByTitle” method.

In Step 3 we will get the object reference to the respective list by calling “GetById” method on Content Types collection.

In Step 4 we will send the batch request to SharePoint Server for processing by calling “ExecuteQuery” method.

In Step 5 we will display a success message to the Users if Step 4 executes successfully.

In Step 6 we will call a function that we have explained in Step 1-5.

Once this script executes successfully we can see a new content type added by navigating “List Settings” of the list as shown below-

We can notice the new content type added to the List Content Types Collection.

Operation - How to “Get List of All Content Types”

We can see this setting available under “List Settings” for the list as shown below,

We can play with this setting using PowerShell as described below,

In Step 1 we will get the object reference to the respective Web in the context in which this code is executing.

In Step 2 we will get the object reference to the respective list by calling “GetByTitle” method.

In Step 3 we will get List Content Types Collection.

In Step 4 we call the “Load” function to retrieve List Content Types Collection properties from the server.

In Step 5 we will send the batch request to SharePoint Server for processing by calling “ExecuteQuery” method.

In Step 6 & 7 we will loop through the Content Types Collection and display relevant properties (ex. Name, ID and so on) from the collection.

In Step 8 we will call the function that we have explained in Step 1-7.

Once this script executes successfully we can see the list of content types by navigating “List Settings” of the list as shown below-

Operation - How to “Delete Existing Content Types” From List

We can see the List of Content Types already added to List under “List Settings” as shown below-

We can delete any Content Type from the list by using PowerShell by using PowerShell as described below-

In Step 1 we will get the object reference to the respective Web in the context in which this code is executing.

In Step 2 we will get the object reference to the respective list by calling “GetByTitle” method.

In Step 3 we will get List Content Types Collection.

In Step 4 we call the “Load” function to retrieve List Content Types Collection properties from the server.

In Step 5 we will send the batch request to SharePoint Server for processing by calling “ExecuteQuery” method.

In Step 6 we will loop through the Content Types Collection.

In Step 7 we will look for required content types that are intended to delete. In this example, we will compare the Content Type Name to ensure that only intended content type is deleted.

In Step 8 we will call “DeleteObject” method to delete the respective content type from Content Types Collection of List.

In Step 9 we will send the batch request to SharePoint Server for processing by calling “ExecuteQuery” method.

In Step 10 we will display the success message after Step 9 got executed successfully.

In Step 11 we will call a function that we have explained in Step 1-10.

Once this script is executed successfully the respective content type will be deleted from Content Types List and this can be verified from the UI by navigating through “List Settings”.

 

Code Snippet

function EnableListContentTypes() {
    $docLib = $clientContext.Web.Lists.GetByTitle("ProductsDocuments");
    $docLib.ContentTypesEnabled = $true;
    $docLib.Update();
    $clientContext.ExecuteQuery();
    Write - Host - ForegroundColor Blue "Content Types Enabled"
}

function AddExistingContetTypeToList() {
    #Custom Content Types by PowerShell - 0x010080D5D9F6B5124249BDCE44D1265E90BF
    $web = $clientContext.Web;
    $list = $clientContext.Web.Lists.GetByTitle("ProductsDocuments")
    $ct = $web.ContentTypes.GetById("0x010080D5D9F6B5124249BDCE44D1265E90BF");
    $addedCt = $list.ContentTypes.AddExistingContentType($ct);
    $clientContext.ExecuteQuery();
}

function GetListContentTypes() {
    $web = $clientContext.Web;
    $list = $web.Lists.GetByTitle("ProductsDocuments");
    $ctColl = $list.ContentTypes;
    $clientContext.Load($ctColl);
    $clientContext.ExecuteQuery();
    foreach($ct in $ctColl) {
        write - host - ForegroundColor blue $ct.Name "-"
        $ct.ID
    }
}

function DeleteListContentType() {
    $web = $clientContext.Web;
    $list = $web.Lists.GetByTitle("ProductsDocuments");
    $ctColl = $list.ContentTypes;
    $clientContext.Load($ctColl);
    $clientContext.ExecuteQuery();
    foreach($ct in $ctColl) {
        if ($ct.Name - eq "Folder") {
            $ct.DeleteObject();
            break;
        }
    }
    $clientContext.ExecuteQuery();
}

That is all for this demo.

Hope you find it helpful.