CloseIncidentRequest CloseIncidentRequest CloseIncidentRequest CloseIncidentRequest Class

Definition

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

For the Web API use the CloseIncident Action.

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
type CloseIncidentRequest = class
    inherit OrganizationRequest
Public NotInheritable Class CloseIncidentRequest
Inherits OrganizationRequest
Inheritance
CloseIncidentRequestCloseIncidentRequestCloseIncidentRequestCloseIncidentRequest
Attributes

Examples



// First close the Incident
// Create resolution for the closing incident
var resolution = new IncidentResolution
{
    Subject = "Case Closed",
};
   resolution.IncidentId = caseReference;

// Create the request to close the incident, and set its resolution to the 
// resolution created above
    var closeRequest = new CloseIncidentRequest();
    closeRequest.IncidentResolution = resolution;
 
// Set the requested new status for the closed Incident
closeRequest.Status = 
    new OptionSetValue((int)incident_statuscode.ProblemSolved);

// Execute the close request
var closeResponse = 
    (CloseIncidentResponse)svc.Execute(closeRequest);

//Check if the incident was successfully closed
var incident = svc.Retrieve(Incident.EntityLogicalName, 
    _caseIncidentId, new ColumnSet(allColumns: true)).ToEntity<Incident>();

if (incident.StateCode.HasValue && 
    incident.StateCode == IncidentState.Resolved)
{
    Console.WriteLine("The incident was closed out as Resolved.");
}
else
{
    Console.WriteLine("The incident's state was not changed.");
}

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. For the complete sample, see the link later in this topic.

BusinessManagement#CloseIncident

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

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 entity.

For a complete list of the required privileges, see CloseIncident message privileges.

Constructors

CloseIncidentRequest() CloseIncidentRequest() CloseIncidentRequest() CloseIncidentRequest()

Initializes a new instance of the CloseIncidentRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
IncidentResolution IncidentResolution IncidentResolution IncidentResolution

Gets or sets the incident resolution (case resolution) that is associated with the incident (case) to be closed. Required.

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
Status Status Status Status

Gets or sets a status of the incident. Required.

Applies to

See also