Implemented WebApi Requests

This page will list all implemented WebApi requests.

The base for the to-be-implemented requests are the MSDN references for actions and functions.

At this point of time, the following requests are implemented and can be executed:

AddToQueueRequest

var request = WebApiClient.Requests.AddToQueueRequest
    .with({
        entityId: "56ae8258-4878-e511-80d4-00155d2a68d1",
        payload: {
            Target: {
                activityid: "59ae8258-4878-e511-80d4-00155d2a68d1",
                "@odata.type": "Microsoft.Dynamics.CRM.letter"
            }
        }
    });

WebApiClient.Execute(request)
    .then(function(response){
        // Process response
    })
    .catch(function(error) {
        // Handle error
    });

PublishXml

var xml = "<importexportxml><entities><entity>account</entity></entities></importexportxml>";

var request = WebApiClient.Requests.AddToQueueRequest
    .with({
        payload: {
            ParameterXml: xml
        }
    });

WebApiClient.Execute(request)
    .then(function(response){
        // Process response
    })
    .catch(function(error) {
        // Handle error
    });

RetrieveLocLabelsRequest

var viewId = "31089fd8-596a-47be-9c9c-3ff82c7a8f8c";
var request = WebApiClient.Requests.RetrieveLocLabelsRequest
    .with({
        urlParams: {
            EntityMoniker: "{'@odata.id':'savedqueries(" + viewId + ")'}",
            AttributeName: "'name'",
            IncludeUnpublished: true
        }
    });

WebApiClient.Execute(request)
.then(function(response){
        // Process response
    })
    .catch(function(error) {
        // Handle error
    });

SetLocLabelsRequest

var viewId = "31089fd8-596a-47be-9c9c-3ff82c7a8f8c";
var request = WebApiClient.Requests.SetLocLabelsRequest
    .with({
        payload: {
            Labels: [],
            EntityMoniker: {
                "@odata.type": "Microsoft.Dynamics.CRM.savedquery",
                savedqueryid: viewId
            },
            AttributeName: "name"
        }
    });

WebApiClient.Execute(request)
.then(function(response){
        // Process response
    })
    .catch(function(error) {
        // Handle error
    });

WhoAmIRequest

var request = WebApiClient.Requests.WhoAmIRequest;

WebApiClient.Execute(request)
    .then(function(response){
        // Process response
    })
    .catch(function(error) {
        // Handle error
    });