CloseIncidentRequest Class

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the CloseIncident Action.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.CloseIncidentRequest

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CloseIncidentRequest : OrganizationRequest

NameDescription
System_CAPS_pubmethodCloseIncidentRequest()

Initializes a new instance of the CloseIncidentRequest class.

NameDescription
System_CAPS_pubpropertyExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyIncidentResolution

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

System_CAPS_pubpropertyItem[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyParameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyStatus

Gets or sets a status of the incident. Required.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

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.



// First close the Incident

// Create resolution for the closing incident
IncidentResolution 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
CloseIncidentRequest 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
CloseIncidentResponse closeResponse = 
    (CloseIncidentResponse)_serviceProxy.Execute(closeRequest);

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

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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: