CloseIncidentRequest Class

 

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)

Inheritance Hierarchy

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

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CloseIncidentRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class CloseIncidentRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod CloseIncidentRequest()

Initializes a new instance of the CloseIncidentRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

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

System_CAPS_pubproperty IncidentResolution

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

System_CAPS_pubproperty Item[String]

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

System_CAPS_pubproperty Parameters

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

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

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

System_CAPS_pubproperty Status

Gets or sets a status of the incident. Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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

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. 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.");
}

Thread Safety

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

See Also

CloseIncidentResponse
Microsoft.Crm.Sdk.Messages Namespace
CloseIncident message privileges
Sample: Validate record state and set the state of the record
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright