Goal entity messages and methods

 

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

A goal represents a target objective for a user or a team for a specified time period.

The early bound class for this entity is Goal. 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 goal to another user.

CreateRequest

Creates a goal. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a goal. You can also call the IOrganizationService.Delete method.

GrantAccessRequest

Shares a goal with another security principal (user or team).

ModifyAccessRequest

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

RecalculateRequest

Recalculates the rollup attribute values for all goals in the goal hierarchy that contain a specified goal.

RetrieveRequest

Retrieves a goal. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

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

RetrievePrincipalAccessRequest

Retrieves the access the specified security principal (user or team) has to a goal.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves all the security principals (users or teams) that have access to a goal, and their access rights to the goal.

RevokeAccessRequest

Removes all access to a goal for the specified security principal (user or team).

SetStateRequest

Sets the state of a goal. If you’re using early bound types, use the GoalState enumeration. For a list of the state values, refer to the Goal entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

Note

Not available in the offline mode.

UpdateRequest

Updates a goal. You can also call the IOrganizationService.Update method.

See Also

Goal management entities
Metric (goal metric) entity messages and methods
Privileges by entity

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright