We have already created parameters with all the data types and for the reference to create parameters you have to have one Custom API. For that Custom API you can create Custom API request Parameters and Custom API Response Properties.<\/p>\n
Move to Make.Powerapps.com>>Solutions>>Open your solution and Add New Item>>Select Custom API, Custom API Request Parameter or Custom API Response Property. The form will appear as shown below.<\/p>\n
Following are the data types available at the time of writing this blog for the custom API request parameter and custom API response property<\/p>\n \u2022 Value: 0 Label: Boolean We will see each different type of data type with an example.<\/p>\n As mentioned above, we have already created Custom API and its parameters. The below Image shows the metadata information of the Custom API Action<\/p>\n 1) Entity Logical Name can only be set for Entity and Entity Reference type of parameter on Custom API Request Parameter form. Please Note: – Executing Custom API from plugin and workflow are very straightforward so we will not be looking into that. We will check in the script how we can execute our Custom API with all possible parameters.<\/p>\n We will be using the Xrm.WebApi.online.execute function to execute our Custom API and in order to execute, we have to create a Request and that request must define our parameter types using Entity Data Model. e.g. Edm.String Structural Property: Structural Property is divided into 5 category and we have to define the value of one them for each parameter.<\/p>\n \u2022 Value 0 for Unknown Type Name: Must be string and it is the qualified name of the parameter type. (Shown into the above image. e.g. Edm.Double )<\/p>\n For Boolean, String, Double, Decimal, Money (Decimal), Date Time, Float, and Integer:<\/p>\n 1) Passing as Input Parameter from the script:<\/p>\n var Sdk = window.Sdk || {}; 2) Read and pass as output parameter from plugin<\/p>\n public void Execute(IServiceProvider serviceProvider) \/\/check the key is present } }<\/p>\n For Guid, StringArray, Entity, EntityCollection, EntityReference, PickList:<\/p>\n 1) Passing as Input Parameter from script:<\/p>\n var Sdk = window.Sdk || {}; \/\/ NOTE: The getMetadata property should be attached to the function prototype instead of the 2) Read and pass as output parameter from plugin:<\/p>\n public void Execute(IServiceProvider serviceProvider) \/\/check the key is present tracing.Trace($”EntityId Input {(entity != null ? entity.Id.ToString() : “Entity input is null”)}”); Above, we have shown how we can use and execute our Custom API with all possible parameters. In the next blog we will be checking how we can register other plugins on the custom API.<\/p>\n Introduction In our previous blog, we have shown brief of custom API and have executed one Custom API request. In this blog, we will be discussing about the different data types available for the Custom API. We will also be explaining to you each one of them, and how we can incorporate it into our\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":[2169,545,592],"class_list":["post-27273","post","type-post","status-publish","format-standard","hentry","category-dynamics-365","category-dynamics-crm","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\/27273","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=27273"}],"version-history":[{"count":0,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/27273\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/media?parent=27273"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/categories?post=27273"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/tags?post=27273"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}![\"execute](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/1-execute-all-available-data-types-in-Custom-API.jpeg\")
<\/a><\/p>\n
\n\u2022 Value: 1 Label: DateTime
\n\u2022 Value: 2 Label: Decimal
\n\u2022 Value: 3 Label: Entity
\n\u2022 Value: 4 Label: EntityCollection
\n\u2022 Value: 5 Label: EntityReference
\n\u2022 Value: 6 Label: Float
\n\u2022 Value: 7 Label: Integer
\n\u2022 Value: 8 Label: Money
\n\u2022 Value: 9 Label: Picklist
\n\u2022 Value: 10 Label: String
\n\u2022 Value: 11 Label: StringArray
\n\u2022 Value: 12 Label: Guid<\/p>\n![\"execute](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/2-execute-all-available-data-types-in-Custom-API.png\")
<\/a><\/p>\n
\n2) Entity Logical Name field is optional even if the parameter type is Entity or Entity Reference.
\n3) If you set Entity Logical Name for any Entity and Entity Reference then it must only contain defined Entity data and Entity Reference.
\n4) Picklist and integer type parameter defined as the same in metadata similarly Decimal and Money type are same in metadata<\/p>\n
\nParameter Types require three properties viz enumProperties(Optional), structuralProperty and typeName. For more details, refer to this<\/a>.<\/p>\n
\n\u2022 Value 1 for Primitive Type
\n\u2022 Value 2 for Complex Type
\n\u2022 Value 3 for Enumeration Type
\n\u2022 Value 4 for Collection
\n\u2022 Value 5 for Entity Type<\/p>\n
\nSdk.PrimitiveRequest = function(stringattribute ,datetimeattribute,moneyattribute,booleanattribute,floatattribute,integerattribute) {
\nthis.stringattribute = stringattribute;
\nthis.datetimeattribute = datetimeattribute;
\nthis.moneyattribute = moneyattribute;
\nthis.booleanattribute = booleanattribute;
\nthis.floatattribute = floatattribute;
\nthis.integerattribute =integerattribute;
\n};
\n\/\/ NOTE: The getMetadata property should be attached to the function prototype instead of the
\n\/\/ function object itself.
\nSdk.PrimitiveRequest.prototype.getMetadata = function () {
\nreturn {
\nboundParameter: null,
\nparameterTypes: {
\n“stringattribute”: {
\n“typeName”: “Edm.String”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n},
\n“datetimeattribute”: {
\n“typeName”: “Edm.DateTimeOffset”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n},
\n“moneyattribute”: {
\n“typeName”: “Edm.Decimal”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n},
\n“booleanattribute”: {
\n“typeName”: “Edm.Boolean”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n},
\n“floatattribute”: {
\n“typeName”: “Edm.Double”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n},
\n“integerattribute”: {
\n“typeName”: “Edm.Int32”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n}
\n},
\noperationType: 0, \/\/ This is an action. Use ‘1’ for functions and ‘2’ for CRUD
\noperationName: “new_passandretrievealldatatypes”,
\n};
\n};
\nvar request =new Sdk.PrimitiveRequest(“string value”,new Date(),500,true,20.5,5);
\nvar result = await Xrm.WebApi.online.execute(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);<\/p>\n
\n\/\/Check the input parameter of string type
\nif (context.InputParameters.Contains(“stringattribute”))
\n{
\nstring inputString = context.InputParameters[“stringattribute”] as string;
\ntracing.Trace($”String Input {inputString}”);
\n\/\/Pass string attribute to the output parameter
\ncontext.OutputParameters[“stringresponse”] = $”This is the response of string parameter {inputString}”;
\n}
\n\/\/Check the input parameter of Money type
\nif (context.InputParameters.Contains(“moneyattribute”))
\n{
\nMoney moneyValue = context.InputParameters[“moneyattribute”] as Money;
\ntracing.Trace($”Money input value {(moneyValue != null ? moneyValue.Value.ToString() : ” : Money value is null “)}”);
\n\/\/Pass money value in the output parameter
\ncontext.OutputParameters[“moneyresponse”] = moneyValue;
\n}
\n\/\/Check the input parameter of boolean type
\nif (context.InputParameters.Contains(“booleanattribute”))
\n{
\nbool booleanAttributeInput = Convert.ToBoolean(context.InputParameters[“booleanattribute”]);
\ntracing.Trace($”Boolean input value : {booleanAttributeInput}”);
\n\/\/Pass the boolean value to output parameter
\ncontext.OutputParameters[“booleanresponse”] = booleanAttributeInput;
\n}
\n\/\/Check the input parameter of Date and Time type
\nif (context.InputParameters.Contains(“datetimeattribute”))
\n{
\nDateTime dateInput = Convert.ToDateTime(context.InputParameters[“datetimeattribute”]);
\ntracing.Trace($”Date and Time input value : {dateInput}”);
\n\/\/pass guid to output parameter
\ncontext.OutputParameters[“datetimeresponse”] = dateInput;
\n}
\n\/\/Check the input parameter of integer type
\nif (context.InputParameters.Contains(“integerattribute”))
\n{
\nint integerInput = Convert.ToInt32(context.InputParameters[“integerattribute”]);
\ntracing.Trace($”integer input value : {integerInput}”);
\n\/\/pass interger output parameter
\ncontext.OutputParameters[“integerresponse”] = integerInput;
\n}
\n\/\/Check the input parameter of double type
\nif (context.InputParameters.Contains(“floatattribute”))
\n{
\ndouble doubleValue = Convert.ToDouble(context.InputParameters[“floatattribute”]);
\ntracing.Trace($”value in double : {doubleValue}”);
\n\/\/pass double output parameter
\ncontext.OutputParameters[“floatresponse”] = doubleValue;
\n}<\/p>\n
\ncatch (Exception ex)
\n{
\nthrow new InvalidPluginExecutionException(ex.InnerException != null && ex.InnerException.Message != null ? ex.InnerException.Message : ex.Message);
\n}<\/p>\n
\nSdk.Request = function(stringarrayattribute,entityattribute,entitycollectionattribute,entityreferenceattribute,guidattribute,picklistattribute) {
\nthis.stringarrayattribute = stringarrayattribute;
\nthis.entitycollectionattribute = entitycollectionattribute;
\nthis.entityreferenceattribute = entityreferenceattribute;
\nthis.entityattribute = entityattribute;
\nthis.guidattribute = guidattribute;
\nthis.picklistattribute = picklistattribute;
\n};<\/p>\n
\n\/\/ function object itself.
\nSdk.Request.prototype.getMetadata = function () {
\nreturn {
\nboundParameter: null,
\nparameterTypes: {
\n“stringarrayattribute”: {
\n“typeName”: “Collection(Edm.String)”,
\n“structuralProperty”: 4 \/\/ Enumeration
\n},
\n“entityattribute”: {
\n“typeName”: “mscrm.crmbaseentity”,
\n“structuralProperty”: 5 \/\/ Entity Type
\n},
\n“entitycollectionattribute”: {
\n“typeName”: “Collection(mscrm.crmbaseentity)”,
\n“structuralProperty”: 4 \/\/ Collection
\n},
\n“entityreferenceattribute”:{
\n“typeName”: “mscrm.crmbaseentity”,
\n“structuralProperty”: 5 \/\/ Entity Type
\n},
\n“guidattribute”:{
\n“typeName”: “Edm.Guid”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n},
\n“picklistattribute”:{
\n“typeName”: “Edm.Int32”,
\n“structuralProperty”: 1 \/\/ Primitive Type
\n}
\n},
\noperationType: 0, \/\/ This is an action. Use ‘1’ for functions and ‘2’ for CRUD
\noperationName: “new_passandretrievealldatatypes”,
\n};
\n};
\n\/\/Define Entity Record
\nvar contactRecord = {
\n“@odata.type”: “Microsoft.Dynamics.CRM.contact”,
\n“firstname”: “Test”,
\n“lastname”: “Account”
\n};
\n\/\/Define Entity Collection
\nvar entityCollection = [contactRecord];
\n\/\/Define Entity reference
\nvar entityRef = {
\n“@odata.type”: “Microsoft.Dynamics.CRM.contact”,
\n“contactid”: “d6208772-d545-eb11-a813-0022481eae24”
\n};
\n\/\/Define String Array
\nvar stringArray =[“str1″,”str2″,”str3”];
\n\/\/Define Guid
\nguid={guid: “E8C656B7-6AD1-E811-A967-000D3A30D5DB”};
\n\/\/pass all parameter to request object created.
\nvar requestObj=new Sdk.Request(stringArray,contactRecord,[contactRecord],contactref,guidParameter,5);
\nvar result = await Xrm.WebApi.online.execute(requestObj);
\nvar response =await result.json();<\/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);<\/p>\n
\n\/\/Check the input parameter of PickList type
\nif (context.InputParameters.Contains(“picklistattribute”))
\n{
\nOptionSetValue optionSetInput = context.InputParameters[“picklistattribute”] as OptionSetValue;
\ntracing.Trace($”Pick List input value : {(optionSetInput != null? optionSetInput.Value.ToString(): “option set value is null”)}”);
\n\/\/pass optionset value parameter
\ncontext.OutputParameters[“picklistresponse”] = optionSetInput != null ? optionSetInput.Value : 0;
\n}
\n\/\/Check the input parameter of StringArray type
\nif (context.InputParameters.Contains(“stringarrayattribute”))
\n{
\nstring[] inputArrayString = context.InputParameters[“stringarrayattribute”] as string[];
\ntracing.Trace($”Array Of String Value {string.Join(“,”, inputArrayString)}”);
\n\/\/Pass string array attribute to the output parameter
\ncontext.OutputParameters[“stringarrayresponse”] = new string[] { “Response data provided” };
\n}
\n\/\/Check the input parameter of Entity type
\nif (context.InputParameters.Contains(“entityattribute”))
\n{
\nEntity entity = context.InputParameters[“entityattribute”] as Entity;<\/p>\n
\n\/\/Pass entity Attribute to the output parameter
\ncontext.OutputParameters[“entityresponse”] = entity;
\n}
\n\/\/Check the input parameter of Entity Collection type
\nif (context.InputParameters.Contains(“entitycollectionattribute”))
\n{
\nEntityCollection entityColl = context.InputParameters[“entitycollectionattribute”] as EntityCollection;
\ntracing.Trace($”Entity Collection count {(entityColl != null ? entityColl.TotalRecordCount.ToString() : “Entity Collection is null “)}”);
\n\/\/pass entity collection to the output parameter
\ncontext.OutputParameters[“entitycollectionresponse”] = entityColl;
\n}
\n\/\/Check the input parameter of Entity Reference type
\nif (context.InputParameters.Contains(“entityreferenceattribute”))
\n{
\nEntityReference entityRef = context.InputParameters[“entityreferenceattribute”] as EntityReference;
\ntracing.Trace($”Entity Refernce {(entityRef != null ? entityRef.Id.ToString() : ” : Entity Ref is null “)}”);
\n\/\/Should be contact
\ncontext.OutputParameters[“entityreferenceresponse”] = entityRef;
\n}
\n\/\/Check the input parameter of Guid type
\nif (context.InputParameters.Contains(“guidattribute”))
\n{
\nGuid guidInput = new Guid(Convert.ToString( context.InputParameters[“guidattribute”]));
\ntracing.Trace($”Guid input value : {guidInput}”);
\n\/\/pass guid to output parameter
\ncontext.OutputParameters[“guidresponse”] = guidInput;
\n}
\n}
\ncatch (Exception ex)
\n{
\nthrow new InvalidPluginExecutionException(ex.InnerException != null && ex.InnerException.Message != null ? ex.InnerException.Message : ex.Message);
\n}
\n}<\/p>\nConclusion<\/h2>\n
![\"\"](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2021\/03\/C2E-1.jpg\")
<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"