Fax entity messages and methods

 

Applies To: Dynamics CRM 2013

This entity represents an activity that tracks call outcome and number of pages for a fax and optionally stores a copy of the document. The schema name for this entity is Fax. 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.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssignRequest	Assigns a fax to another user or team.
AssociateRequest	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, see the Fax entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
CreateRequest	Creates a fax. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes a fax. You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. For a list of default relationships for this entity, see the Fax entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
GrantAccessRequest	Shares a fax with another security principal (user or team).
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
ModifyAccessRequest	Changes the access rights for a fax previously shared with another security principal (user or team).
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves a fax. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of faxes. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access that the specified security principal (user or team) has to a fax.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to a fax, and their access rights to the fax.
RevokeAccessRequest	Removes all access to a fax for the specified security principal (user or team).
SendFaxRequest	Sends a fax.
SetStateRequest	Sets the state of a fax. The possible values for this attribute are defined in the Fax.State attribute. If you are using early bound types, you can use the FaxState enumeration. For a list of possible states, see the Fax entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UpdateRequest	Updates a fax. You can also call the IOrganizationService.Update method.

See Also

Activity entities
Task, fax, phone call, and letter activity entities
Letter entity messages and methods
Fax entity privileges