Skip to main content

Unlocking Sitecore Content Hub: A Guide to Utilizing the Web Client SDK - Part 2

Unlocking Sitecore Content Hub: A Guide to Utilizing the Web Client SDK - Part 2

The previous blog discussed how to authenticate using the OAuth client. The Web Client SDK includes an Entities client for executing CRUD operations—such as reading, creating, updating, and deleting entities—in Content Hub. For more details, you can visit Sitecore's Web Client SDK documentation. Here are some examples of CRUD operations on entities.

Create Entities

To create the entity, use the EntityFactory to instantiate an Entity, set its properties using SetPropertyValue, and then call the SaveAsync method to save the changes.

  public static async Task<long> CreateAssestEntity()  
     {  
       IEntity asset = await MClientConnector.Client.EntityFactory.CreateAsync("M.Asset").ConfigureAwait(false);  
       asset.SetPropertyValue("Title", "This is a test Asset");  
       return await MClientConnector.Client.Entities.SaveAsync(asset).ConfigureAwait(false);  
     }  
  internal class Program  
   {  
     static async Task Main(string[] args)  
     {  
       try  
       {  
         var id=await CreateEntity.CreateAssestEntity();  
       }  
       catch (Exception ex)  
       {  
         Console.WriteLine(ex.Message);  
       }  
     }  
   }  


Read Entities

In the GetAsync method, the entity ID needs to be passed. GetAsync method will return IEntity.

  public static Task<IEntity> GetAssetEntity()  
     {  
       long entityId = 1523729;  
       return MClientConnector.Client.Entities.GetAsync(entityId);  
     }  
  internal class Program  
   {  
     static async Task Main(string[] args)  
     {  
       try  
       {  
         var entity=await GetEntity.GetAssetEntity();  
       }  
       catch (Exception ex)  
       {  
         Console.WriteLine(ex.Message);  
       }  
     }  
   }  

Update Entities

To update the entity, begin by invoking the GetAsync method with the entity ID to retrieve an IEntity. After obtaining the IEntity, modify its properties using SetPropertyValue. Finally, call the SaveAsync method to persist the changes.

  public static async Task<long> UpdateAssetEntity()  
     {  
       long entityId = 1523729;  
       IEntity asset = await MClientConnector.Client.Entities.GetAsync(entityId);  
       asset.SetPropertyValue("Title", "This is a updated test Asset");  
       return await MClientConnector.Client.Entities.SaveAsync(asset).ConfigureAwait(false);  
     }  

  internal class Program  
   {  
     static async Task Main(string[] args)  
     {  
       try  
       {  
         var entity = await UpdateEntity.UpdateAssetEntity();  
       }  
       catch (Exception ex)  
       {  
         Console.WriteLine(ex.Message);  
       }  
     }  
   }  

Delete Entities

To delete the entity, call the DeleteAsync method with the entity ID.
    public static Task DeleteAssetEntity()  
     {  
       long entityId = 1523729;  
       return MClientConnector.Client.Entities.DeleteAsync(entityId);  
     }  

   internal class Program  
   {  
     static async Task Main(string[] args)  
     {  
       try  
       {  
         await DeleteEntity.DeleteAssetEntity();  
       }  
       catch (Exception ex)  
       {  
         Console.WriteLine(ex.Message);  
       }  
     }  
   }  


Comments

Popular posts from this blog

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine’” on Windows 11

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine' ” on Windows 11 Today I started to install Sitecore 10.2 using Sitecore Instance Manager on Windows 11 and I got this issue “Failed to start service ‘Sitecore Marketing Automation Engine' ” . Error : On event viewer it was showing the below error: I also tried to run ‘ Sitecore.MAEngine.exe ’ like this C:\Windows\system32>C:\inetpub\wwwroot\sclocal102xconnect.dev.local\App_Data\jobs\continuous\AutomationEngine\Sitecore.MAEngine.exe Which was throwing below error: Starting Marketing Automation Engine... 2022-01-29 22:21:11 ERR Error initializing XConnect client. System.AggregateException: One or more errors occurred. ---> Sitecore.XConnect.XdbCollectionUnavailableException: An error occurred while sending the request. ---> System.Net.Http.HttpRequestException: An error occurred while sending the request. ---> System.Net.WebException: The underlying connection was closed: An unexpected err...

Sitecore Custom API Issue with Federation Authentication

Sitecore Custom API Issue with Federation Authentication In earlier segments, detailed in Part 1 and Part 2 of the blogs on Keycloak Integration with Sitecore, I introduced Keycloak functionality for CM login. Concurrently, I addressed a necessity to develop custom APIs for retrieving Sitecore users and roles. Following the development of custom APIs, during authentication failures, the API erroneously returned a status code of 200 instead of 401. The problem arose because API requests were being routed through the "owin.identityProviders" pipeline, which was not intended for API usage. Solution: When OWIN identifies a 401 response and the AuthenticationMode is set to "Active," it fails to capture the URL hash included in the request. Another choice is to activate the "Passive" AuthenticationMode, wherein OWIN refrains from actively intercepting 401 responses. In passive mode, your application needs to explicitly issue a Challenge to trigger the OWIN aut...

Azure AD Integration with Sitecore 10.2

 Azure AD Integration with Sitecore 10.2 Sitecore identity server that comes with Sitecore 9.1 allows you to log in through an external identity provider like Azure Active Directory, Facebook, Apple, or Google. It is built on Federation Authentication. What is Federation Authentication? Federation authentication is a technology to allows users to access multiples application, tools, and domains using one credential. Using one set of credential user can access multiple applications, and resources after authentication.  Federation authentication consists of two systems, the Identity provider and the Service provider. Identity providers that maintain/create/manage identity information like name, email address, device, and location. Some examples of identity providers are Azure AD, Google, Facebook, and Apple. Service providers basically refer to a website, software, or app that the user is trying to access and SP basically relies on the identity provider to authenticate the user ...