CloseIncidentRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the data that is needed to close an incident (case).

public ref class CloseIncidentRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CloseIncidentRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type CloseIncidentRequest = class
    inherit OrganizationRequest

Public NotInheritable Class CloseIncidentRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
CloseIncidentRequest

Attributes: DataContractAttribute

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface instance. For the complete sample, see the link later in this topic.

/// <summary>
/// Demonstrates the CloseIncident message
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="caseReference">A reference to the case to close</param>
static void CloseIncidentExample(IOrganizationService service, EntityReference caseReference)
{
      // First close the Incident

      // Create resolution for the closing incident
      Entity resolution = new("incidentresolution")
      {
         Attributes =
         {
            {"subject", "Case Closed"},
            {"incidentid", caseReference}
         }
      };

      // Create the request to close the incident, and set its resolution to the 
      // resolution created above
      CloseIncidentRequest request = new()
      {
         IncidentResolution = resolution,
         Status = new OptionSetValue(5) // Problem Solved
      };

      // Execute the close request
      service.Execute(request);

      //Check if the incident was successfully closed
      Entity incident = service.Retrieve(
         entityName: "incident",
         id: caseReference.Id,
         columnSet: new ColumnSet("statecode", "statuscode"));

      int statecode = incident.GetAttributeValue<OptionSetValue>("statecode").Value;
      int statuscode = incident.GetAttributeValue<OptionSetValue>("statuscode").Value;

      if (statecode == 1 && statuscode == 5)
      {
         Console.WriteLine("The incident was closed out as Resolved.");
      }
      else
      {
         Console.WriteLine("The incident's state was not changed.");
      }
}

For a complete sample on GitHub, see Dynamics365-Apps-Samples Sample: Close an incident

Remarks

This message requires Dynamics 365 Customer Service.

For the Web API use the CloseIncident action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the CloseIncidentResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Incident table.

The caller must have the following privileges:

prvCreateActivity
prvAppendToIncident
prvAppendActivity
prvWriteIncident
prvDeleteQueueItem
prvReadActivity
prvWriteActivity

Constructors

CloseIncidentRequest()

Initializes a new instance of the CloseIncidentRequest class.

Properties

ExtensionData	Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest)
IncidentResolution	Gets or sets the incident resolution (case resolution) that is associated with the incident (case) to be closed. Required.
Item[String]	Gets or sets the indexer for the `Parameters` collection. (Inherited from OrganizationRequest)
Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
RequestId	Gets or sets the ID of the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
Status	Gets or sets a status of the incident. Required.

Applies to

Dela via