Incident (case) entity messages and methods
Applies To: Dynamics CRM 2013
An incident (case) is a customer service issue, which is a problem that is defined by a customer and the collection of activities that occur in the case to resolve the problem.
The schema name for this entity is Incident. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.
Note
The incident entity ResponsibleContactId lookup attribute should be considered deprecated and the PrimaryContactId lookup attribute introduced with the CRM Online Spring ‘14 and Microsoft Dynamics CRM 2013 Service Pack 1 (SP1) release should be considered the primary system lookup attribute to associate incidents with a contact record.
There are no plans to remove the ResponsibleContactId lookup attribute, but if you plan to create new customizations you should use PrimaryContactId rather than ResponsibleContactId. If you have existing customizations that currently use ResponsibleContactId, you should consider migrating them to use PrimaryContactId instead.
The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.
Message |
Description |
|---|---|
This message was added in the CRM Online Spring ‘14 and Microsoft Dynamics CRM 2013 Service Pack 1 (SP1) release. Applies the active routing rule to the case. |
|
Assigns an incident to another user or team. |
|
Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the Incident entity metadata. You can find this information in the metadata for your organization. More information: Browse the metadata for your organization |
|
Calculates the total time that was spent on the incident. |
|
Sets the state of the incident to Closed. |
|
Creates an incident. You can also call the IOrganizationService.Create method. |
|
Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. More information: Actions on entity records. For a list of default relationships for this entity, refer to the Incident entity metadata. You can find this information in the metadata for your organization. More information: Browse the metadata for your organization |
|
Deletes an incident. You can also call the IOrganizationService.Delete method. |
|
Shares an incident with another security principal (user or team). |
|
Validates if the incident is ready to be closed. |
|
Merging Incidents was added with the Microsoft Dynamics CRM Online Spring ‘14 and Microsoft Dynamics CRM 2013 Service Pack 1 (SP1) release. Note The behavior of a merge operation for incidents is different from merging accounts, contacts, or leads. More information: MergeRequest |
|
Changes the access rights for an incident previously shared with another security principal (user or team). |
|
Retrieves an incident. You can also call the IOrganizationService.Retrieve method. |
|
Retrieves a collection of incidents. You can also call the IOrganizationService.RetrieveMultiple method. |
|
Retrieves the access rights that the specified security principal (user or team) has to an incident. |
|
Retrieves all the security principals (users or teams) that have access to an incident, together with their access rights to the incident. |
|
Removes all access rights to an incident for the specified security principal (user or team). |
|
Rolls up or retrieves all the incidents related to the specified incident or contact. |
|
Sets the state of an incident. If you’re using early bound types, use the IncidentState enumeration to set the possible states. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. |
|
Updates an incident. You can also call the IOrganizationService.Update method. |
See Also
Incident (case) entities
IncidentResolution (case resolution) entity messages and methods
Sample: Close an incident
Incident (Case) entity privileges