static void Main()
{
//List of Uris for records created in this sample
List <Uri> entityUris = new List <Uri>();
bool deleteCreatedRecords = true;
try
{
using (CDSWebApiService svc = new CDSWebApiService(config))
{
Console.WriteLine("--Starting Basic Operations--");
#region Section 1: Basic Create and Update operations
Console.WriteLine("--Section 1 started--");
//Create a contact
var contact1 = new JObject
{
{ "firstname", "Rafel" },
{ "lastname", "Shillo" }
};
Uri contact1Uri = svc.PostCreate("contacts", contact1);
Console.WriteLine($"Contact '{contact1["firstname"]} " +
$"{contact1["lastname"]}' created.");
entityUris.Add(contact1Uri); //To delete later
Console.WriteLine($"Contact URI: {contact1Uri}");
//Update a contact
JObject contact1Add = new JObject
{
{ "annualincome", 80000 },
{ "jobtitle", "Junior Developer" }
};
svc.Patch(contact1Uri, contact1Add);
Console.WriteLine(
$"Contact '{contact1["firstname"]} {contact1["lastname"]}' " +
$"updated with jobtitle and annual income");
//Retrieve a contact
var retrievedcontact1 = svc.Get(contact1Uri.ToString() +
"?$select=fullname,annualincome,jobtitle,description");
Console.WriteLine($"Contact '{retrievedcontact1["fullname"]}' retrieved: \n" +
$"\tAnnual income: {retrievedcontact1["annualincome"]}\n" +
$"\tJob title: {retrievedcontact1["jobtitle"]} \n" +
//description is initialized empty.
$"\tDescription: {retrievedcontact1["description"]}.");
//Modify specific properties and then update entity instance.
JObject contact1Update = new JObject
{
{ "jobtitle", "Senior Developer" },
{ "annualincome", 95000 },
{ "description", "Assignment to-be-determined" }
};
svc.Patch(contact1Uri, contact1Update);
Console.WriteLine($"Contact '{retrievedcontact1["fullname"]}' updated:\n" +
$"\tJob title: {contact1Update["jobtitle"]}\n" +
$"\tAnnual income: {contact1Update["annualincome"]}\n" +
$"\tDescription: {contact1Update["description"]}\n");
// Change just one property
string telephone1 = "555-0105";
svc.Put(contact1Uri.ToString(), "telephone1", telephone1);
Console.WriteLine($"Contact '{retrievedcontact1["fullname"]}' " +
$"phone number updated.");
//Now retrieve just the single property.
var telephone1Value = svc.Get($"{contact1Uri}/telephone1");
Console.WriteLine($"Contact's telephone # is: {telephone1Value["value"]}.");
#endregion Section 1: Basic Create and Update operations
#region Section 2: Create record associated to another
/// <summary>
/// Demonstrates creation of entity instance and simultaneous association to another,
/// existing entity.
/// </summary>
///
Console.WriteLine("\n--Section 2 started--");
//Create a new account and associate with existing contact in one operation.
var account1 = new JObject
{
{ "name", "Contoso Ltd" },
{ "telephone1", "555-5555" },
{ "*****@*****.**", contact1Uri }
};
var account1Uri = svc.PostCreate("accounts", account1);
entityUris.Add(account1Uri); //To delete later
Console.WriteLine($"Account '{account1["name"]}' created.");
Console.WriteLine($"Account URI: {account1Uri}");
//Retrieve account name and primary contact info
JObject retrievedAccount1 = svc.Get($"{account1Uri}?$select=name," +
$"&$expand=primarycontactid($select=fullname,jobtitle,annualincome)") as JObject;
Console.WriteLine($"Account '{retrievedAccount1["name"]}' has primary contact " +
$"'{retrievedAccount1["primarycontactid"]["fullname"]}':");
Console.WriteLine($"\tJob title: {retrievedAccount1["primarycontactid"]["jobtitle"]} \n" +
$"\tAnnual income: {retrievedAccount1["primarycontactid"]["annualincome"]}");
#endregion Section 2: Create record associated to another
#region Section 3: Create related entities
/// <summary>
/// Demonstrates creation of entity instance and related entities in a single operation.
/// </summary>
///
Console.WriteLine("\n--Section 3 started--");
//Create the following entries in one operation: an account, its
// associated primary contact, and open tasks for that contact. These
// entity types have the following relationships:
// Accounts
// |---[Primary] Contact (N-to-1)
// |---Tasks (1-to-N)
//Build the Account object inside-out, starting with most nested type(s)
JArray tasks = new JArray();
JObject task1 = new JObject
{
{ "subject", "Sign invoice" },
{ "description", "Invoice #12321" },
{ "scheduledend", DateTimeOffset.Parse("4/19/2019") }
};
tasks.Add(task1);
JObject task2 = new JObject
{
{ "subject", "Setup new display" },
{ "description", "Theme is - Spring is in the air" },
{ "scheduledstart", DateTimeOffset.Parse("4/20/2019") }
};
tasks.Add(task2);
JObject task3 = new JObject
{
{ "subject", "Conduct training" },
{ "description", "Train team on making our new blended coffee" },
{ "scheduledstart", DateTimeOffset.Parse("6/1/2019") }
};
tasks.Add(task3);
JObject contact2 = new JObject
{
{ "firstname", "Susie" },
{ "lastname", "Curtis" },
{ "jobtitle", "Coffee Master" },
{ "annualincome", 48000 },
//Add related tasks using corresponding navigation property
{ "Contact_Tasks", tasks }
};
JObject account2 = new JObject
{
{ "name", "Fourth Coffee" },
//Add related contacts using corresponding navigation property
{ "primarycontactid", contact2 }
};
//Create the account and related records
Uri account2Uri = svc.PostCreate("accounts", account2);
Console.WriteLine($"Account '{account2["name"]} created.");
entityUris.Add(account2Uri); //To delete later
Console.WriteLine($"Contact URI: {account2Uri}");
//Retrieve account, primary contact info, and assigned tasks for contact.
//CDS only supports querying-by-expansion one level deep, so first query
// account-primary contact.
var retrievedAccount2 = svc.Get($"{account2Uri}?$select=name," +
$"&$expand=primarycontactid($select=fullname,jobtitle,annualincome)");
Console.WriteLine($"Account '{retrievedAccount2["name"]}' " +
$"has primary contact '{retrievedAccount2["primarycontactid"]["fullname"]}':");
Console.WriteLine($"\tJob title: {retrievedAccount2["primarycontactid"]["jobtitle"]} \n" +
$"\tAnnual income: {retrievedAccount2["primarycontactid"]["annualincome"]}");
//Next retrieve same contact and its assigned tasks.
//Don't have a saved URI for contact 'Susie Curtis', so create one
// from base address and entity ID (and add it to collection for cleanup).
Uri contact2Uri = new Uri($"{svc.BaseAddress}contacts({retrievedAccount2["primarycontactid"]["contactid"]})");
entityUris.Add(contact2Uri); //To delete later
//Retrieve the contact
var retrievedcontact2 = svc.Get($"{contact2Uri}?$select=fullname," +
$"&$expand=Contact_Tasks($select=subject,description,scheduledstart,scheduledend)");
Console.WriteLine($"Contact '{retrievedcontact2["fullname"]}' has the following assigned tasks:");
foreach (JToken tk in retrievedcontact2["Contact_Tasks"])
{
Console.WriteLine(
$"Subject: {tk["subject"]}, \n" +
$"\tDescription: {tk["description"]}\n" +
$"\tStart: {tk["scheduledstart"].Value<DateTime>():d}\n" +
$"\tEnd: {tk["scheduledend"].Value<DateTime>():d}\n");
}
#endregion Section 3: Create related entities
#region Section 4: Associate and Disassociate entities
/// <summary>
/// Demonstrates associating and disassociating of existing entity instances.
/// </summary>
Console.WriteLine("\n--Section 4 started--");
//Add 'Rafel Shillo' to the contact list of 'Fourth Coffee',
// a 1-to-N relationship.
JObject rel1 = new JObject
{
{ "@odata.id", contact1Uri }
}; //relationship object for msg content
Uri navUri1 = new Uri($"{account2Uri}/contact_customer_accounts/$ref");
//Create relationship
svc.Post(navUri1.ToString(), rel1);
Console.WriteLine($"Contact '{retrievedcontact1["fullname"]}' " +
$"associated to account '{account2["name"]}'.");
//Retrieve and output all contacts for account 'Fourth Coffee'.
var retrievedContactList1 = svc.Get($"{account2Uri}/contact_customer_accounts?" +
$"$select=fullname,jobtitle");
Console.WriteLine($"Contact list for account '{retrievedAccount2["name"]}':");
foreach (JToken ct in retrievedContactList1["value"])
{
Console.WriteLine($"\tName: {ct["fullname"]}, Job title: {ct["jobtitle"]}");
}
//Dissociate the contact from the account. For a collection-valued
// navigation property, must append URI of referenced entity.
var dis1Uri = $"{navUri1}?$id={contact1Uri}";
//Equivalently, could have dissociated from the other end of the
// relationship, using the single-valued navigation ref, located in
// the contact 'Peter Cambel'. This dissociation URI has a simpler form:
// [Org URI]/api/data/v9.1/contacts([contactid#])/parentcustomerid_account/$ref
svc.Delete(dis1Uri);
//'Rafel Shillo' was removed from the the contact list of 'Fourth Coffee'
//Associate an opportunity to a competitor, an N-to-N relationship.
//First, create the required entity instances.
JObject comp1 = new JObject
{
{ "name", "Adventure Works" },
{
"strengths",
"Strong promoter of private tours for multi-day outdoor adventures"
}
};
Uri comp1Uri = svc.PostCreate("competitors", comp1);
entityUris.Add(comp1Uri); //To delete later
JObject oppor1 = new JObject
{
["name"] = "River rafting adventure",
["description"] = "Sales team on a river-rafting offsite and team building"
};
Uri oppor1Uri = svc.PostCreate("opportunities", oppor1);
entityUris.Add(oppor1Uri); //To delete later
//Associate opportunity to competitor via opportunitycompetitors_association.
// navigation property.
JObject rel2 = new JObject
{
{ "@odata.id", comp1Uri }
};
Uri navUri2 = new Uri($"{oppor1Uri}/opportunitycompetitors_association/$ref");
svc.Post(navUri2.ToString(), rel2);
Console.WriteLine($"Opportunity '{oppor1["name"]}' associated with competitor '{comp1["name"]}'.");
//Retrieve all opportunities for competitor 'Adventure Works'.
var retrievedOpporList1 = svc.Get($"{comp1Uri}?$select=name,&$expand=opportunitycompetitors_association($select=name,description)");
Console.WriteLine($"Competitor '{retrievedOpporList1["name"]}' has the following opportunities:");
foreach (JToken op in
retrievedOpporList1["opportunitycompetitors_association"])
{
Console.WriteLine($"\tName: {op["name"]}, \n" +
$"\tDescription: {op["description"]}");
}
//Dissociate opportunity from competitor.
svc.Delete($"{navUri2}?$id={comp1Uri}");
// 'River rafting adventure' opportunity disassociated with 'Adventure Works' competitor
#endregion Section 4: Associate and Disassociate entities
#region Section 5: Delete sample entities
Console.WriteLine("\n--Section 5 started--");
//Delete all the created sample entities. Note that explicit deletion is not required
// for contact tasks because these are automatically cascade-deleted with owner.
if (!deleteCreatedRecords)
{
Console.Write("\nDo you want these entity records deleted? (y/n) [y]: ");
String answer = Console.ReadLine();
answer = answer.Trim();
if (!(answer.StartsWith("y") || answer.StartsWith("Y") || answer == string.Empty))
{
entityUris.Clear();
}
else
{
Console.WriteLine("\nDeleting created records.");
}
}
else
{
Console.WriteLine("\nDeleting created records.");
}
foreach (Uri entityUrl in entityUris)
{
svc.Delete(entityUrl.ToString());
}
#endregion Section 5: Delete sample entities
Console.WriteLine("--Basic Operations Completed--");
Console.WriteLine("Press any key to close");
Console.ReadLine();
}
}
catch (Exception)
{
throw;
}
}
/// <summary>
/// Creates the entity instances used by the main demonstration code.
/// </summary>
/// <param name="svc">The service class used for messaging.</param>
/// <param name="entityUris">A collection of entity instance Uri for tracking and
/// later deletion (cleanup).</param>
private static void CreateRequiredRecords(CDSWebApiService svc, Dictionary <string, Uri> entityUris)
{
Console.WriteLine("* Creating required records");
// Create a parent account
JObject parentAccountAttributes = new JObject()
{
{ "name", "Fourth Coffee" }
};
entityUris.Add("Fourth Coffee",
CreateEntity(svc, "accounts", parentAccountAttributes));
// Create an incident with three associated tasks
JArray taskAttributess = new JArray(new JObject[]
{
JObject.Parse(@"{subject: 'Task 1', actualdurationminutes: 30}"),
JObject.Parse(@"{subject: 'Task 2', actualdurationminutes: 30}"),
JObject.Parse(@"{subject: 'Task 3', actualdurationminutes: 30}")
});
JObject incidentAttributes = new JObject()
{
{ "title", "Sample Case" },
{ "*****@*****.**", entityUris["Fourth Coffee"] },
{ "Incident_Tasks", taskAttributess }
};
entityUris.Add("Sample Case",
CreateEntity(svc, "incidents", incidentAttributes));
// Close the associated tasks so that they represent completed work
try
{
Console.Write("\tSetting each incident task to completed..");
JToken incidentTaskRefs = svc.Get(entityUris["Sample Case"] + "/Incident_Tasks/$ref");
// Property value set used to mark tasks as completed.
JObject completeCode = JObject.Parse(@"{statecode: 1, statuscode: 5}");
foreach (JToken taskId in incidentTaskRefs["value"])
{
var taskUri = new Uri(taskId["@odata.id"].ToString());
svc.Patch(taskUri, completeCode);
}
Console.WriteLine("done.");
}
catch (ServiceException e)
{
Console.WriteLine("failed.");
throw e;
}
//Create another account and associated opportunity (required for CloseOpportunityAsWon)
JObject wineryAccountAttributes = new JObject()
{
{ "name", "Coho Winery" },
{ "opportunity_customer_accounts", JArray.Parse(@"[{ name: 'Opportunity to win' }]") }
};
entityUris.Add("Coho Winery",
CreateEntity(svc, "accounts", wineryAccountAttributes));
//Retrieve the URI of the associated opportunity
try
{
Console.Write("\tRetrieving the URI of the opportunity 'Opportunity to win'..");
JToken custOpporRefs = svc.Get(entityUris["Coho Winery"] + "/opportunity_customer_accounts/$ref");
entityUris.Add("Opportunity to win",
new Uri(custOpporRefs["value"][0]["@odata.id"].ToString()));
Console.WriteLine("completed.");
}
catch (ServiceException e)
{
Console.WriteLine("failed.");
throw e;
}
//Create a contact to use with custom action sample_AddNoteToContact
JObject contactAttributes = JObject.Parse(@"{firstname: 'Jon', lastname: 'Fogg'}");
entityUris.Add("Jon Fogg",
CreateEntity(svc, "contacts", contactAttributes));
Console.WriteLine("* Finished creating required records");
}
static void Main()
{
// Save the URIs for entity records created in this sample. so they
// can be deleted later.
List <Uri> entityUris = new List <Uri>();
try
{
// Use the wrapper class that handles message processing, error handling, and more.
using (CDSWebApiService svc = new CDSWebApiService(config))
{
Console.WriteLine("--Starting conditional operations demonstration--\n");
#region Create required records
// Create an account record
var account1 = new JObject {
{ "name", "Contoso Ltd" },
{ "telephone1", "555-0000" }, //Phone number value increments with each update attempt
{ "revenue", 5000000 },
{ "description", "Parent company of Contoso Pharmaceuticals, etc." }
};
Uri account1Uri = svc.PostCreate("accounts", account1);
entityUris.Add(account1Uri); // Track any created records
// Retrieve the account record that was just created.
string queryOptions = "?$select=name,revenue,telephone1,description";
var retrievedaccount1 = svc.Get(account1Uri.ToString() + queryOptions);
// Store the ETag value from the retrieved record
string initialAcctETagVal = retrievedaccount1["@odata.etag"].ToString();
Console.WriteLine("Created and retrieved the initial account, shown below:");
Console.WriteLine(retrievedaccount1.ToString(Formatting.Indented));
#endregion Create required records
#region Conditional GET
Console.WriteLine("\n** Conditional GET demonstration **");
// Attempt to retrieve the account record using a conditional GET defined by a message header with
// the current ETag value.
try
{
retrievedaccount1 = svc.Get(
path: account1Uri.ToString() + queryOptions,
headers: new Dictionary <string, List <string> > {
{ "If-None-Match", new List <string> {
initialAcctETagVal
} }
}
);
// Not expected; the returned response contains content.
Console.WriteLine("Instance retrieved using ETag: {0}", initialAcctETagVal);
Console.WriteLine(retrievedaccount1.ToString(Formatting.Indented));
}
catch (AggregateException ae) // Message was not successful
{
ae.Handle((x) =>
{
if (x is ServiceException) // This we know how to handle.
{
var e = x as ServiceException;
if (e.StatusCode == (int)HttpStatusCode.NotModified) // Expected result
{
Console.WriteLine("Account record retrieved using ETag: {0}", initialAcctETagVal);
Console.WriteLine("Expected outcome: Entity was not modified so nothing was returned.");
return(true);
}
}
return(false); // Let anything else stop the application.
});
}
// Modify the account instance by updating the telephone1 attribute
svc.Put(account1Uri, "telephone1", "555-0001");
Console.WriteLine("\n\bAccount telephone number updated to '555-0001'.\n");
// Re-attempt to retrieve using conditional GET defined by a message header with
// the current ETag value.
try
{
retrievedaccount1 = svc.Get(
path: account1Uri.ToString() + queryOptions,
headers: new Dictionary <string, List <string> > {
{ "If-None-Match", new List <string> {
initialAcctETagVal
} }
}
);
// Expected result
Console.WriteLine("Modified account record retrieved using ETag: {0}", initialAcctETagVal);
Console.WriteLine("Notice the update ETag value and telephone number");
}
catch (ServiceException e)
{
if (e.StatusCode == (int)HttpStatusCode.NotModified) // Not expected
{
Console.WriteLine("Unexpected outcome: Entity was modified so something should be returned.");
}
else
{
throw e;
}
}
// Save the updated ETag value
var updatedAcctETagVal = retrievedaccount1["@odata.etag"].ToString();
// Display ty updated record
Console.WriteLine(retrievedaccount1.ToString(Formatting.Indented));
#endregion Conditional GET
#region Optimistic concurrency on delete and update
Console.WriteLine("\n** Optimistic concurrency demonstration **");
// Attempt to delete original account (if matches original ETag value).
// If you replace "initialAcctETagVal" with "updatedAcctETagVal", the delete will
// succeed. However, we want the delete to fail for now to demonstrate use of the ETag.
Console.WriteLine("Attempting to delete the account using the original ETag value");
try
{
svc.Delete(
uri: account1Uri,
headers: new Dictionary <string, List <string> > {
{ "If-Match", new List <string> {
initialAcctETagVal
} }
}
);
// Not expected; this code should not execute.
Console.WriteLine("Account deleted");
}
catch (ServiceException e)
{
if (e.StatusCode == (int)HttpStatusCode.PreconditionFailed) // Expected result
{
Console.WriteLine("Expected Error: The version of the account record no" +
" longer matches the original ETag.");
Console.WriteLine("\tAccount not deleted using ETag '{0}', status code: '{1}'.",
initialAcctETagVal, e.StatusCode);
}
else
{
throw e;
}
}
Console.WriteLine("Attempting to update the account using the original ETag value");
JObject accountUpdate = new JObject()
{
{ "telephone1", "555-0002" },
{ "revenue", 6000000 }
};
try
{
svc.Patch(
uri: account1Uri,
body: accountUpdate,
headers: new Dictionary <string, List <string> > {
{ "If-Match", new List <string> {
initialAcctETagVal
} }
}
);
// Not expected; this code should not execute.
Console.WriteLine("Account updated using original ETag {0}", initialAcctETagVal);
}
catch (ServiceException e)
{
if (e.StatusCode == (int)HttpStatusCode.PreconditionFailed) // Expected error
{
Console.WriteLine("Expected Error: The version of the existing record doesn't "
+ "match the ETag property provided.");
Console.WriteLine("\tAccount not updated using ETag '{0}', status code: '{1}'.",
initialAcctETagVal, (int)e.StatusCode);
}
else
{
throw e;
}
}
// Reattempt update if matches current ETag value.
accountUpdate["telephone1"] = "555-0003";
Console.WriteLine("Attempting to update the account using the current ETag value");
try
{
svc.Patch(
uri: account1Uri,
body: accountUpdate,
headers: new Dictionary <string, List <string> > {
{ "If-Match", new List <string> {
updatedAcctETagVal
} }
}
);
// Expected program flow; this code should execute.
Console.WriteLine("\nAccount successfully updated using ETag: {0}.",
updatedAcctETagVal);
}
catch (ServiceException e)
{
if (e.StatusCode == (int)HttpStatusCode.PreconditionFailed) // Not expected
{
Console.WriteLine("Unexpected status code: '{0}'", (int)e.StatusCode);
}
else
{
throw e;
}
}
// Retrieve and output current account state.
retrievedaccount1 = svc.Get(account1Uri.ToString() + queryOptions);
Console.WriteLine("\nBelow is the final state of the account");
Console.WriteLine(retrievedaccount1.ToString(Formatting.Indented));
#endregion Optimistic concurrency on delete and update
#region Delete created records
// Delete (or keep) all the created entity records.
Console.Write("\nDo you want these entity records deleted? (y/n) [y]: ");
String answer = Console.ReadLine().Trim();
if (!(answer.StartsWith("y") || answer.StartsWith("Y") || answer == string.Empty))
{
entityUris.Clear();
}
foreach (Uri entityUrl in entityUris)
{
svc.Delete(entityUrl);
}
#endregion Delete created records
}
}
catch (ServiceException e)
{
Console.WriteLine("Message send response: status code {0}, {1}",
e.StatusCode, e.ReasonPhrase);
}
}