Let\u2019s create a custom API similarly to retrieve multiple as we have in Dynamics 365. However, we will extend the limit of 5000 records per request to 20000 per request.<\/p>\n
We will be passing a table name and columns as parameters to Custom API and our Custom API should send back the response with the data based on the same.<\/p>\n
Let us go with the code first approach for this Custom API.<\/p>\n
We have written an Assembly shown below that has three input parameters and two Output Parameters.<\/p>\n
Input Parameters:<\/strong><\/p>\n \u2022 Table Name (Entity) Output Parameters:<\/strong><\/p>\n \u2022 Values Create Assembly:<\/strong><\/p>\n public void Execute(IServiceProvider serviceProvider) query.ColumnSet = new ColumnSet(columns); }<\/p>\n context.OutputParameters[“values”] = eCollection; } throw new InvalidPluginExecutionException(ex.InnerException != null && ex.InnerException.Message != null ? ex.InnerException.Message : ex.Message); }<\/p>\n Now create the Custom API record as below:<\/strong><\/p>\n As mentioned above, create three Input parameters:<\/strong><\/p>\n 1) Table Name:<\/strong> A required parameter to be passed to Custom API for retrieving entity-specific data.<\/p>\n 2) Columns:<\/strong> An optional parameter, which will define the columns to be retrieved by our request.<\/p>\n 3) Cookie:<\/strong> Paging Cookie, in case we have more than 20000 and for getting data in a sequence after every request.<\/p>\n Output Parameters:<\/strong><\/p>\n 1) Values: <\/strong>Since this Custom API can be used to retrieve data of any table, we have deliberately left the Logical Entity Name blank, which means that Entity Collection can be of any table.<\/p>\n 2) Cookie: <\/strong>Paging Cookie that needs to be passed along the next request for the same table.<\/p>\n We have completed with the configuration part. Now we can execute our Custom API.<\/p>\n Move to a browser and execute the custom function as shown below.<\/p>\n custom_retrievetabledata is our Custom API table, columns and cookie are our parameters, amongst them table is our required parameters.<\/p>\n For passing parameters as QueryString, you can create aliases for the parameters and then execute it as below.<\/p>\n First, we need to create parameter aliases, which shall reference the parameter, and using that aliases we can pass the parameters as QueryString. Please note for creating parameter aliases we need to use the \u2018@\u2019 keyword else, it will give us an error. You can read more about it from here<\/a>.<\/p>\n Execute it using Fetch API.<\/p>\n await (await fetch(“\/api\/data\/v9.2\/custom_retrievetabledata(table=’account’,columns=’name,telephone1′)”)).json()<\/p>\n Execute using Xrm.WebApi.online.execute function. \/\/ NOTE: The getMetadata property should be attached to the function prototype instead of the \/\/ Construct a request object from the metadata This way we can create and execute the function type Custom API.<\/p>\n Introduction In the last blog, we saw how we could execute all available data types in Custom API. In this blog, we will be creating Custom Function using Custom API. Let\u2019s create a custom API similarly to retrieve multiple as we have in Dynamics 365. However, we will extend the limit of 5000 records per\u2026 Read More »<\/a><\/span><\/p>\n","protected":false},"author":13,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[16,19],"tags":[2201,2169,545,592],"class_list":["post-27281","post","type-post","status-publish","format-standard","hentry","category-dynamics-365","category-dynamics-crm","tag-create-custom-function","tag-custom-api","tag-dynamics-365-crm","tag-dynamics-crm"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/27281","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/comments?post=27281"}],"version-history":[{"count":0,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/27281\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/media?parent=27281"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/categories?post=27281"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/tags?post=27281"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
\n\u2022 Columns Name (Field)
\n\u2022 Cookie (This is the paging cooking, in case there are more than 20000 records and the Custom API needs to be called a second time to get the other 20000 records).<\/p>\n
\n\u2022 Cookie (Paging Cooking that needs to be passed to the next request)<\/p>\n
\n{
\ntry
\n{ \/\/ tracing object
\nITracingService tracing = (ITracingService)serviceProvider.GetService(typeof(ITracingService));
\n\/\/ ExecutionContext object
\nIPluginExecutionContext context = (IPluginExecutionContext)serviceProvider.GetService(typeof(IPluginExecutionContext));
\n\/\/ object Organization service factory object
\nIOrganizationServiceFactory serviceFactory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));
\n\/\/ object organization object
\nIOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);
\nstring cookie = context.InputParameters.Contains(“cookie”) ? Convert.ToString(context.InputParameters[“cookie”]) : string.Empty;
\nbool moreRecords = false;
\nint pageNumber = !string.IsNullOrEmpty(cookie) ? Convert.ToInt32(cookie.Substring(cookie.IndexOf(“page=”) + 6, 1)) : 1;
\nif (pageNumber > 1)
\nmoreRecords = true;
\nEntityCollection eCollection = new EntityCollection();
\ntracing.Trace($”Before Request”);
\n\/\/check the key is present
\nif (context.InputParameters.Contains(“table”))
\n{
\n\/*We get the 5000 max record per request using OOB way,
\n* For making to 20000 records max we will be executing OOB request to max for time *\/
\nfor (int i = 0; i < 4; i++)
\n{
\ntracing.Trace($”Loop number {i}”);
\n\/\/Create queryexpression query
\nvar query = new QueryExpression(Convert.ToString(context.InputParameters[“table”]));
\n\/\/define dynamic variable for storing the columns
\ndynamic columns = context.InputParameters.Contains(“columns”) ? Convert.ToString(context.InputParameters[“columns”]) : string.Empty;
\nif (string.IsNullOrEmpty(columns))
\ncolumns = true;
\nelse
\ncolumns = columns.Split(‘,’);<\/p>\n
\n\/\/If more records are there
\nif (moreRecords)
\n{
\nquery.PageInfo.PagingCookie = cookie;
\nquery.PageInfo.PageNumber = pageNumber;
\n}
\nvar result = service.RetrieveMultiple(query);
\n\/\/Add the all records in the collection variable
\neCollection.Entities.AddRange(result.Entities.AsEnumerable());
\ntracing.Trace($”data Count {eCollection.Entities.Count}”);
\ncookie = result.PagingCookie;
\nmoreRecords = result.MoreRecords;
\npageNumber = pageNumber + 1;
\nif (!moreRecords)
\nbreak;<\/p>\n
\ncontext.OutputParameters[“cookie”] = cookie;
\ntracing.Trace($”Cookie {cookie}”);
\ntracing.Trace($”After OutPut Parameter set”);
\n}<\/p>\n
\ncatch (Exception ex)
\n{<\/p>\n
\n}<\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/1-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/2-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/3-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/4-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/5-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/6-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/7-Create-Custom-Function-using-Custom-API-in-Dynamics-365.png\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/8-Create-Custom-Function-using-Custom-API-in-Dynamics-365.png\")
<\/a><\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/9-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\n
\nvar getTableData= async function(tableName){
\nvar Request = {};
\n\/**
\n* Request to Get All Relationship Count
\n* @param {String} EntityName – Entity Logical Name.
\n*\/
\nRequest = function(table) {
\nthis.table = table;
\n};<\/p>\n
\n\/\/ function object itself.
\nRequest.prototype.getMetadata = function () {
\nreturn {
\nboundParameter: null,
\nparameterTypes: {
\n“table”: {
\n“typeName”: “Edm.String”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n}
\n},
\noperationType: 1, \/\/ This is an action. Use ‘1’ for functions and ‘2’ for CRUD
\noperationName: “custom_retrievetabledata”,
\n};
\n};<\/p>\n
\nvar req = new Request(tableName);
\nresult = await Xrm.WebApi.online.execute(req);
\nreturn await result.json();
\n}<\/p>\n![\"Create](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/10-Create-Custom-Function-using-Custom-API-in-Dynamics-365.jpeg\")
<\/a><\/p>\nConclusion<\/h2>\n
![\"\"](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/c2c-1.jpg\")
<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"