GetChangedUofMScheduleKeyList


Description

Retrieves a list of changed unit of measure schedule key objects for the unit of measure schedules that have been acted on during the specified interval. A unit of measure schedule has been acted on if it has been created, updated, or deleted. Entity change tracking must be enabled for this method to return valid results.

Parameters

Parameter

Type

Description

criteria

UofMScheduleChangedKeyCriteria

The unit of measure schedule changed key criteria object that specifies which changed unit of measure schedule key objects to return.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetChangedUofMScheduleKeyListResult

ArrayOfChangedUofMScheduleKey

The list of changed unit of measure schedule key objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of the changed unit of measure schedule key objects for all of the unit of measure schedules that were created, updated, or deleted over the last week. A message box displays the number of unit of measure schedules that had each action type performed on them.

 Legacy endpoint

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			UofMScheduleChangedKeyCriteria UofMCriteria;
			ChangedUofMScheduleKey[] changedUofMScheduleKeyObjects;
			BetweenRestrictionOfNullableOfDateTime restriction;

			// Create an instance of the service
			DynamicsGP wsDynamicsGP = new DynamicsGP();

			// Be sure the default credentials are used
			wsDynamicsGP.UseDefaultCredentials = true;

			// Create a context with which to call the service
			context = new Context();

			// Specify which company to use (sample company)
			companyKey = new CompanyKey();
			companyKey.Id = (-1);

			// Set up the context object
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create the restriction that defines the interval examined for changes
			// The following restriction includes the last week
			restriction = new BetweenRestrictionOfNullableOfDateTime();
			restriction.From = DateTime.Today.Date.AddDays(-7);
			restriction.To = DateTime.Today.Date.AddDays(1);

			// Create the criteria to return unit of measure objects that changed
			UofMCriteria = new UofMScheduleChangedKeyCriteria();
			UofMCriteria.LastModifiedDate = restriction;

			// Retrieve the changed unit of measure key objects
			changedUofMScheduleKeyObjects = wsDynamicsGP.GetChangedUofMScheduleKeyList(UofMCriteria, context);

			// Display the numbers of unit of measure schedules that were acted on this week
			int created = 0;
			int updated = 0;
			int deleted = 0;

			foreach (ChangedUofMScheduleKey key in changedUofMScheduleKeyObjects)
			{
				if (key.Action == DataModificationAction.Created)
					created++;

				if (key.Action == DataModificationAction.Updated)
					updated++;

				if (key.Action == DataModificationAction.Deleted)
					deleted++;
		}

			string message;
			message = "U of M objects: \n";
			message = message + "Created: " + created.ToString() + "\n";
			message = message + "Updated: " + updated.ToString() + "\n";
			message = message + "Deleted: " + deleted.ToString() + "\n";

			MessageBox.Show(message);
	}
}
}

 Native endpoint

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			UofMScheduleChangedKeyCriteria UofMCriteria;
			ChangedUofMScheduleKey[] changedUofMScheduleKeyObjects;
			BetweenRestrictionOfNullableOfdateTime restriction;

			// Create an instance of the service
			DynamicsGPClient wsDynamicsGP = new DynamicsGPClient();

			// Create a context with which to call the service
			context = new Context();

			// Specify which company to use (sample company)
			companyKey = new CompanyKey();
			companyKey.Id = (-1);

			// Set up the context object
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create the restriction that defines the interval examined for changes
			// The following restriction includes the last week
			restriction = new BetweenRestrictionOfNullableOfdateTime();
			restriction.From = DateTime.Today.Date.AddDays(-7);
			restriction.To = DateTime.Today.Date.AddDays(1);

			// Create the criteria to return unit of measure objects that changed
			UofMCriteria = new UofMScheduleChangedKeyCriteria();
			UofMCriteria.LastModifiedDate = restriction;

			// Retrieve the changed unit of measure key objects
			changedUofMScheduleKeyObjects = wsDynamicsGP.GetChangedUofMScheduleKeyList(UofMCriteria, context);

			// Display the numbers of unit of measure schedules that were acted on this week
			int created = 0;
			int updated = 0;
			int deleted = 0;

			foreach (ChangedUofMScheduleKey key in changedUofMScheduleKeyObjects)
			{
				if (key.Action == DataModificationAction.Created)
					created++;

				if (key.Action == DataModificationAction.Updated)
					updated++;

				if (key.Action == DataModificationAction.Deleted)
					deleted++;
		}

			string message;
			message = "U of M objects: \n";
			message = message + "Created: " + created.ToString() + "\n";
			message = message + "Updated: " + updated.ToString() + "\n";
			message = message + "Deleted: " + deleted.ToString() + "\n";

			MessageBox.Show(message);

			// Close the service
			if(wsDynamicsGP.State != CommunicationState.Faulted)
			{
				wsDynamicsGP.Close();
		}
	}
}
}


Documentation Feedback