Category: Development

How to share record with user using WebApi

01/11/201801/11/2018 | by Andrew Butenko | Leave a Comment

You can use following code to share record (account in this case) with user (but you can share it with team as well) using JavaScript and WebApi without any additional development:

var target = {
		"accountid": "ACAAB842-21C7-E811-A96F-000D3A16A41E",
		//put <other record type>id and Guid of record to share here
		"@odata.type": "Microsoft.Dynamics.CRM.account"
		//replace account with other record type
};

var principalAccess = {
		"Principal": {
			"systemuserid": "d272654b-57f5-4564-8d0b-36d0d4c426c4",
			//put teamid here and Guid of team if you want to share with team
			"@odata.type": "Microsoft.Dynamics.CRM.systemuser"
			//put team instead of systemuser if you want to share with team
		},
		"AccessMask": "ReadAccess, WriteAccess"
		//full list of privileges is "ReadAccess, WriteAccess, AppendAccess, AppendToAccess, CreateAccess, DeleteAccess, ShareAccess, AssignAccess"
};

var parameters = {
    "Target": target,
    "PrincipalAccess": principalAccess
};

var context;

if (typeof GetGlobalContext === "function") {
    context = GetGlobalContext();
} else {
    context = Xrm.Page.context;
}

var req = new XMLHttpRequest();
req.open("POST", context.getClientUrl() + "/api/data/v9.0/GrantAccess", true);
req.setRequestHeader("OData-MaxVersion", "4.0");
req.setRequestHeader("OData-Version", "4.0");
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.onreadystatechange = function () {
    if (this.readyState === 4) {
        req.onreadystatechange = null;
        if (this.status === 204) {
            //Success - No Return Data - Do Something
        } else {
            var errorText = this.responseText;
            //Error and errorText variable contains an error - do something with it
        }
    }
};
req.send(JSON.stringify(parameters));

var target = {

"accountid": "ACAAB842-21C7-E811-A96F-000D3A16A41E",

//put <other record type>id and Guid of record to share here

"@odata.type": "Microsoft.Dynamics.CRM.account"

//replace account with other record type

};

var principalAccess = {

"Principal": {

"systemuserid": "d272654b-57f5-4564-8d0b-36d0d4c426c4",

//put teamid here and Guid of team if you want to share with team

"@odata.type": "Microsoft.Dynamics.CRM.systemuser"

//put team instead of systemuser if you want to share with team

"AccessMask": "ReadAccess, WriteAccess"

//full list of privileges is "ReadAccess, WriteAccess, AppendAccess, AppendToAccess, CreateAccess, DeleteAccess, ShareAccess, AssignAccess"

};

var parameters = {

"Target": target,

"PrincipalAccess": principalAccess

};

var context;

if (typeof GetGlobalContext === "function") {

context = GetGlobalContext();

} else {

context = Xrm.Page.context;

}

var req = new XMLHttpRequest();

req.open("POST", context.getClientUrl() + "/api/data/v9.0/GrantAccess", true);

req.setRequestHeader("OData-MaxVersion", "4.0");

req.setRequestHeader("OData-Version", "4.0");

req.setRequestHeader("Accept", "application/json");

req.setRequestHeader("Content-Type", "application/json; charset=utf-8");

req.onreadystatechange = function () {

if (this.readyState === 4) {

req.onreadystatechange = null;

if (this.status === 204) {

//Success - No Return Data - Do Something

} else {

var errorText = this.responseText;

//Error and errorText variable contains an error - do something with it

}

};

req.send(JSON.stringify(parameters));

Blog, Development, Howto

How to call QuerySchedule using WebApi

11/07/2018 | by Andrew Butenko | 2 Comments

Following code can be used to call QuerySchedule function using WebApi:

var context;

if (typeof GetGlobalContext === "function") {
    context = GetGlobalContext();
} else {
    context = Xrm.Page.context;
}

var start = new Date(); //Put Start datetime here

var end = new Date(); //Put End datetime here
end.setDate(end.getDate() + 1);

var requestUrl = "/api/data/v8.2/QuerySchedule(ResourceId=@p1,Start=@p2,End=@p3,TimeCodes=@p4)";
requestUrl += "?@p1=" + context.getUserId().replace("{", "").replace("}", "");
//put Id of resource you want get data for as parameter 1

requestUrl += "&@p2=" + JSON.stringify(start).replace(/"/g, "");
requestUrl += "&@p3=" + JSON.stringify(end).replace(/"/g, "");
requestUrl += "&@p4=" + JSON.stringify(['0']);

//For TimeCodes use '0' for Available
//'1' for Busy
//'2' for Unavailable
//'3' for Filter

var req = new XMLHttpRequest();
req.open("GET", context.getClientUrl() + requestUrl, true);
req.setRequestHeader("OData-MaxVersion", "4.0");
req.setRequestHeader("OData-Version", "4.0");
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.onreadystatechange = function() {
    if (this.readyState === 4) {
        req.onreadystatechange = null;

        if (this.status === 200) {
            var results = JSON.parse(this.response);
            //you've got results to results variable
        } else {
            var errorText = this.responseText;
            //handle error here
        }
    }
};
req.send();

var context;

if (typeof GetGlobalContext === "function") {

context = GetGlobalContext();

} else {

context = Xrm.Page.context;

}

var start = new Date(); //Put Start datetime here

var end = new Date(); //Put End datetime here

end.setDate(end.getDate() + 1);

var requestUrl = "/api/data/v8.2/QuerySchedule(ResourceId=@p1,Start=@p2,End=@p3,TimeCodes=@p4)";

requestUrl += "?@p1=" + context.getUserId().replace("{", "").replace("}", "");

//put Id of resource you want get data for as parameter 1

requestUrl += "&@p2=" + JSON.stringify(start).replace(/"/g, "");

requestUrl += "&@p3=" + JSON.stringify(end).replace(/"/g, "");

requestUrl += "&@p4=" + JSON.stringify(['0']);

//For TimeCodes use '0' for Available

//'1' for Busy

//'2' for Unavailable

//'3' for Filter

var req = new XMLHttpRequest();

req.open("GET", context.getClientUrl() + requestUrl, true);

req.setRequestHeader("OData-MaxVersion", "4.0");

req.setRequestHeader("OData-Version", "4.0");

req.setRequestHeader("Accept", "application/json");

req.setRequestHeader("Content-Type", "application/json; charset=utf-8");

req.onreadystatechange = function() {

if (this.readyState === 4) {

req.onreadystatechange = null;

if (this.status === 200) {

var results = JSON.parse(this.response);

//you've got results to results variable

} else {

var errorText = this.responseText;

//handle error here

}

};

req.send();

Blog, Development, Howto

How to Add Item to Campaign using WebApi

21/06/2018 | by Andrew Butenko | Leave a Comment

Following JS (with small changes) can be used to add Marketing List/Product/Sales Literature to Campaign:

var parameters = {
	Campaign: {
		campaignid: "E5EE91B6-7A75-E811-A95F-000D3A33EB4E",
		//put valid if of campaign here
		"@odata.type": "Microsoft.Dynamics.CRM.campaign"
	}
};
 
var context;
 
if (typeof GetGlobalContext === "function") {
    context = GetGlobalContext();
} else {
    context = Xrm.Page.context;
}
 
var req = new XMLHttpRequest();
req.open("POST", context.getClientUrl() + 
	"/api/data/v8.2/lists(2DBBE7F5-7A75-E811-A95F-000D3A33EB4E)/Microsoft.Dynamics.CRM.AddItemCampaign", true);
//replace collection name and record id with record you want to add to campaign
req.setRequestHeader("OData-MaxVersion", "4.0");
req.setRequestHeader("OData-Version", "4.0");
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.onreadystatechange = function () {
    if (this.readyState === 4) {
        req.onreadystatechange = null;
        if (this.status === 204) {
            //Success - No Return Data - Do Something
        } else {
            var errorText = this.responseText;
            //Error and errorText variable contains an error - do something with it
        }
    }
};
req.send(JSON.stringify(parameters));

var parameters = {

Campaign: {

campaignid: "E5EE91B6-7A75-E811-A95F-000D3A33EB4E",

//put valid if of campaign here

"@odata.type": "Microsoft.Dynamics.CRM.campaign"

}

};

var context;

if (typeof GetGlobalContext === "function") {

context = GetGlobalContext();

} else {

context = Xrm.Page.context;

}

var req = new XMLHttpRequest();

req.open("POST", context.getClientUrl() +

"/api/data/v8.2/lists(2DBBE7F5-7A75-E811-A95F-000D3A33EB4E)/Microsoft.Dynamics.CRM.AddItemCampaign", true);

//replace collection name and record id with record you want to add to campaign

req.setRequestHeader("OData-MaxVersion", "4.0");

req.setRequestHeader("OData-Version", "4.0");

req.setRequestHeader("Accept", "application/json");

req.setRequestHeader("Content-Type", "application/json; charset=utf-8");

req.onreadystatechange = function () {

if (this.readyState === 4) {

req.onreadystatechange = null;

if (this.status === 204) {

//Success - No Return Data - Do Something

} else {

var errorText = this.responseText;

//Error and errorText variable contains an error - do something with it

}

};

req.send(JSON.stringify(parameters));

Blog, Development, Howto

How to generate Excel Template from code

19/03/201819/03/2018 | by Andrew Butenko | Leave a Comment

2 years ago as a part of Dynamics CRM 2016 release Microsoft introduced “Word/Excel Document Templates”. I saw examples how to generate Word template but have never seen the same example for Excel. Here is what I found after several hours spent with DB of CRM and ILSpy:

var request = new OrganizationRequest("RenderTemplateFromView");
request["Template"] = new EntityReference("documenttemplate", new Guid("ECF388DE-1033-4C7C-93F3-0803B16C09C7"));
request["View"] = new EntityReference("savedquery", new Guid("00000000-0000-0000-00AA-000010003001"));

var response = service.Execute(request);

var fileContent = (byte[]) response["ExcelFile"];

//Do whatever you need with file content - I saved it to hard drive
File.WriteAllBytes("GeneratedExcel.xlsx", fileContent);

var request = new OrganizationRequest("RenderTemplateFromView");

request["Template"] = new EntityReference("documenttemplate", new Guid("ECF388DE-1033-4C7C-93F3-0803B16C09C7"));

request["View"] = new EntityReference("savedquery", new Guid("00000000-0000-0000-00AA-000010003001"));

var response = service.Execute(request);

var fileContent = (byte[]) response["ExcelFile"];

//Do whatever you need with file content - I saved it to hard drive

File.WriteAllBytes("GeneratedExcel.xlsx", fileContent);

Huge limitation of this code – …

Development, Howto

How to use SendEmailFromTemplate action with JavaScript and WebApi

02/03/2018 | by Andrew Butenko | Leave a Comment

var parameters = {
    TemplateId: "07B94C1D-C85F-492F-B120-F0A743C540E6",//Guid of template
    Regarding: {
        contactid: "CA26BD09-62B4-E711-A94F-000D3A109280",//entity that will be used for templating
        "@odata.type": "Microsoft.Dynamics.CRM.contact"
    },
    Target: {//stub of email that has to contain at least one valid recipient
        "@odata.type": "Microsoft.Dynamics.CRM.email",
        email_activity_parties: [{
            "partyid_contact@odata.bind": "/contacts(CA26BD09-62B4-E711-A94F-000D3A109280)",
            participationtypemask: 2//To
        }]
    }
};

var context;

if (typeof GetGlobalContext === "function") {
    context = GetGlobalContext();
} else {
    context = Xrm.Page.context;
}

var req = new XMLHttpRequest();
req.open("POST", context.getClientUrl() + "/api/data/v8.2/SendEmailFromTemplate", true);
req.setRequestHeader("OData-MaxVersion", "4.0");
req.setRequestHeader("OData-Version", "4.0");
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.onreadystatechange = function () {
    if (this.readyState === 4) {
        req.onreadystatechange = null;
        if (this.status === 200) {
            //Success - No Return Data - Do Something
        } else {
            var errorText = this.responseText;
            //Error and errorText variable contains an error - do something with it
        }
    }
};
req.send(JSON.stringify(parameters));

var parameters = {

TemplateId: "07B94C1D-C85F-492F-B120-F0A743C540E6",//Guid of template

Regarding: {

contactid: "CA26BD09-62B4-E711-A94F-000D3A109280",//entity that will be used for templating

"@odata.type": "Microsoft.Dynamics.CRM.contact"

Target: {//stub of email that has to contain at least one valid recipient

"@odata.type": "Microsoft.Dynamics.CRM.email",

email_activity_parties: [{

"partyid_contact@odata.bind": "/contacts(CA26BD09-62B4-E711-A94F-000D3A109280)",

participationtypemask: 2//To

}]

}

};

var context;

if (typeof GetGlobalContext === "function") {

context = GetGlobalContext();

} else {

context = Xrm.Page.context;

}

var req = new XMLHttpRequest();

req.open("POST", context.getClientUrl() + "/api/data/v8.2/SendEmailFromTemplate", true);

req.setRequestHeader("OData-MaxVersion", "4.0");

req.setRequestHeader("OData-Version", "4.0");

req.setRequestHeader("Accept", "application/json");

req.setRequestHeader("Content-Type", "application/json; charset=utf-8");

req.onreadystatechange = function () {

if (this.readyState === 4) {

req.onreadystatechange = null;

if (this.status === 200) {

//Success - No Return Data - Do Something

} else {

var errorText = this.responseText;

//Error and errorText variable contains an error - do something with it

}

};

req.send(JSON.stringify(parameters));

Development, Howto

How to Add records to Marketing List using WebApi

01/03/201802/03/2018 | by Andrew Butenko | Leave a Comment

Following code can be used to add records to Marketing List using JavaScript and WebApi:

var parameters = {
    List: {
        listid: "9DEE7D76-611D-E811-A95B-000D3A1087A0",
        "@odata.type": "Microsoft.Dynamics.CRM.list"
    },
    Members: [{
        accountid: "3653A521-A2C0-E711-A950-000D3A109280",
        "@odata.type": "Microsoft.Dynamics.CRM.account"
    }]
};

var context;

if (typeof GetGlobalContext === "function") {
    context = GetGlobalContext();
} else {
    context = Xrm.Page.context;
}

var req = new XMLHttpRequest();
req.open("POST", context.getClientUrl() + "/api/data/v8.2/AddListMembersList", true);
req.setRequestHeader("OData-MaxVersion", "4.0");
req.setRequestHeader("OData-Version", "4.0");
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.onreadystatechange = function () {
    if (this.readyState === 4) {
        req.onreadystatechange = null;
        if (this.status === 204) {
            //Success - No Return Data - Do Something
        } else {
            var errorText = this.responseText;
            //Error and errorText variable contains an error - do something with it
        }
    }
};
req.send(JSON.stringify(parameters));

var parameters = {

List: {

listid: "9DEE7D76-611D-E811-A95B-000D3A1087A0",

"@odata.type": "Microsoft.Dynamics.CRM.list"

Members: [{

accountid: "3653A521-A2C0-E711-A950-000D3A109280",

"@odata.type": "Microsoft.Dynamics.CRM.account"

}]

};

var context;

if (typeof GetGlobalContext === "function") {

context = GetGlobalContext();

} else {

context = Xrm.Page.context;

}

var req = new XMLHttpRequest();

req.open("POST", context.getClientUrl() + "/api/data/v8.2/AddListMembersList", true);

req.setRequestHeader("OData-MaxVersion", "4.0");

req.setRequestHeader("OData-Version", "4.0");

req.setRequestHeader("Accept", "application/json");

req.setRequestHeader("Content-Type", "application/json; charset=utf-8");

req.onreadystatechange = function () {

if (this.readyState === 4) {

req.onreadystatechange = null;

if (this.status === 204) {

//Success - No Return Data - Do Something

} else {

var errorText = this.responseText;

//Error and errorText variable contains an error - do something with it

}

};

req.send(JSON.stringify(parameters));

Blog, Development, Howto, Reports

Microsoft Dynamics 365 v9.0: How to fix connectivity issues between SSDT + Report Authoring Extension and Dynamics 365

14/02/201815/02/2018 | by Andrew Butenko | 9 Comments

At the moment (February 14, 2018) Microsoft hasn’t released version of Report Authoring Extension that supports both v9.0 and enforced TLS 1.2. This post will help people who develops reports for latest Dynamics 365 v9.0 using SQL Server Data Tools and FetchXml Authoring Extension.

Blog, Development

Microsoft Dynamics 365 v9.0: lookupObjects – closer look

22/11/201722/11/2017 | by Andrew Butenko | 7 Comments

After I posted my previous post about new namespaces and methods I got several questions about lookupObjects method from Xrm.Utility namespace. I decided to make additional research to check what was not documented but can be used.

Blog, Development

Microsoft Dynamics 365 v9.0: What’s new in clientside for devs besides Xrm.WebApi

21/11/201703/12/2017 | by Andrew Butenko | 10 Comments

After analysis of new namespaces and methods that were released as a part of new 9.0 version I come to conclusion that “Dynamics 365 CE” Product Team actively works on elimination of gap between methods that are available to Product Team and usual developers. And here is why:

Development, Howto

Microsoft Dynamics 365 v9.0: Usage of new OOB WebApi functions – Part 3

18/10/2017 | by Andrew Butenko | 1 Comment

In previous posts I described how to use Xrm.WebApi methods to perform CRUD operations and use “execute” method to call Actions. This part is dedicated to functions.