Entitlement entity messages and methods

  • Article

 

Applies To: Dynamics CRM 2013

The Entitlement entity is available in organizations that have updated to CRM Online Spring ‘14 or Microsoft Dynamics CRM 2013 Service Pack 1 (SP1) (on-premises). This entity is not used in organizations that upgraded to CRM Online Spring ‘14 or Microsoft Dynamics CRM 2013 Service Pack 1 (SP1) until the product updates enabling enhanced service capabilities are applied. More information: Detect enhanced service capabilities available with product updates.

The schema name for this entity is Entitlement. 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 an entitlement to another user or team.

CreateRequest

Creates an entitlement. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes an entitlement. You can also call the IOrganizationService.Delete method.

GrantAccessRequest

Shares an entitlement with another security principal (user or team).

ModifyAccessRequest

Changes the access rights for an entitlement previously shared with another security principal (user or team).

RenewEntitlementRequest

Renews an entitlement.

RetrieveRequest

Retrieves an entitlement. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of entitlements. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access the specified security principal (user or team) has to an entitlement.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a contract, together with their access rights to the entitlement.

RevokeAccessRequest

Removes all access to an entitlement for the specified security principal (user or team).

SetStateRequest

Sets the state of an entitlement. For a list of the state values, see the options available in the metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

UpdateRequest

Updates an entitlement. You can also call the IOrganizationService.Update method.

See Also

Entitlement entities
EntitlementChannel entity messages and methods
EntitlementTemplate entity messages and methods
EntitlementTemplateChannel entity messages and methods