goal EntityType
Description: Target objective for a user or a team for a specified time period.
Entity Set path: [organization URI]/api/data/v8.0/goals
Base Type: crmbaseentity EntityType
Display Name: Goal
Primary Key: goalid
Primary Name Attribute: title
Properties
Single-valued navigation properties
Collection-valued navigation properties
Operations bound to goal
Operations using the goal entity type.
Properties
Properties represent fields of data stored in the entity. Some properties are not writable.
| Name | Type | Details |
|---|---|---|
_createdby_value |
Edm.Guid |
Description: Shows who created the record. Computed property Read-only property |
_createdonbehalfby_value |
Edm.Guid |
Description: Shows who created the record on behalf of another user. Computed property Read-only property |
_goalownerid_value |
Edm.Guid |
Description: Choose the user or team responsible for meeting the goal. Computed property Read-only property |
_goalwitherrorid_value |
Edm.Guid |
Description: Unique identifier of the goal that caused an error in the rollup of the goal hierarchy. Computed property Read-only property |
_metricid_value |
Edm.Guid |
Description: Choose the metric for the goal. This metric determines how the goal is tracked. Computed property Read-only property |
_modifiedby_value |
Edm.Guid |
Description: Shows who last updated the record. Computed property Read-only property |
_modifiedonbehalfby_value |
Edm.Guid |
Description: Shows who last updated the record on behalf of another user. Computed property Read-only property |
_ownerid_value |
Edm.Guid |
Description: Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user. |
_owningbusinessunit_value |
Edm.Guid |
Description: Unique identifier for the business unit that owns the record. Computed property Read-only property |
_owningteam_value |
Edm.Guid |
Description: Unique identifier of the team who owns the goal. Computed property Read-only property |
_owninguser_value |
Edm.Guid |
Description: Unique identifier for the user who owns the record. Computed property Read-only property |
_parentgoalid_value |
Edm.Guid |
Description: Choose a parent goal if the current goal is a child goal. This sets up a parent-child relationship for reporting and analytics. Computed property Read-only property |
_rollupqueryactualdecimalid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate the actual data for the goal (decimal). Computed property Read-only property |
_rollupqueryactualintegerid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate the actual data for the goal (integer). Computed property Read-only property |
_rollupqueryactualmoneyid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate the actual data for the goal (money). Computed property Read-only property |
_rollupquerycustomdecimalid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate data for the custom rollup field (decimal). Computed property Read-only property |
_rollupquerycustomintegerid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate data for the custom rollup field (integer). Computed property Read-only property |
_rollupquerycustommoneyid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate data for the custom rollup field (money). Computed property Read-only property |
_rollupqueryinprogressdecimalid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate data for the in-progress rollup field (decimal). Computed property Read-only property |
_rollupqueryinprogressintegerid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate data for the in-progress rollup field (integer). Computed property Read-only property |
_rollupqueryinprogressmoneyid_value |
Edm.Guid |
Description: Choose the query that will be used to calculate data for the in-progress rollup field (money). Computed property Read-only property |
_transactioncurrencyid_value |
Edm.Guid |
Description: Choose the local currency for the record to make sure budgets are reported in the correct currency. Computed property Read-only property |
actualdecimal |
Edm.Decimal |
Description: Shows the actual value (Decimal type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Decimal. Display Name: Actual (Decimal) |
actualinteger |
Edm.Int32 |
Description: Shows the actual value (integer) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount or Count and the amount data type is Integer. Display Name: Actual (Integer) |
actualmoney |
Edm.Decimal |
Description: Shows the actual value (Money type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Money. Display Name: Actual (Money) |
actualmoney_base |
Edm.Decimal |
Description: Shows the actual value (money type) in base currency to track goal results against the target. Display Name: Actual (Money) (Base) Read-only property |
actualstring |
Edm.String |
Description: Actual Value of the goal. Display Name: Actual Read-only property |
amountdatatype |
Edm.Int32 |
Description: Data type of the amount. Default Options: 0 : Money Display Name: Amount Data Type |
computedtargetasoftodaydecimal |
Edm.Decimal |
Description: Shows the expected amount for actual value (decimal type) against the target goal. Display Name: Today's Target (Decimal) Read-only property |
computedtargetasoftodayinteger |
Edm.Int32 |
Description: Shows the expected amount for actual value (integer type) against the target goal as of the current date. Display Name: Today's Target (Integer) Read-only property |
computedtargetasoftodaymoney |
Edm.Decimal |
Description: Shows the expected amount for actual value (money type) against the target goal as of the current date. Display Name: Today's Target (Money) Read-only property |
computedtargetasoftodaymoney_base |
Edm.Decimal |
Description: Shows the expected amount in base currency for actual value (money type) against the target goal as of the current date. Display Name: Today's Target (Money) (Base) Read-only property |
computedtargetasoftodaypercentageachieved |
Edm.Decimal |
Description: Shows the expected value for percentage achieved against the target goal as of the current date. Display Name: Today's Target (Percentage Achieved) Read-only property |
consideronlygoalownersrecords |
Edm.Boolean |
Description: Select whether only the goal owner's records, or all records, should be rolled up for goal results. Default Options: 1 : Owned by goal owner Display Name: Record Set for Rollup |
createdon |
Edm.DateTimeOffset |
Description: Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options. Display Name: Created On Read-only property |
customrollupfielddecimal |
Edm.Decimal |
Description: Indicates a placeholder rollup field for a decimal value to track a third category of results other than actuals and in-progress results. Display Name: Custom Rollup Field (Decimal) |
customrollupfieldinteger |
Edm.Int32 |
Description: Indicates a placeholder rollup field for an integer value to track a third category of results other than actuals and in-progress results. Display Name: Custom Rollup Field (Integer) |
customrollupfieldmoney |
Edm.Decimal |
Description: Indicates a placeholder rollup field for a money value to track a third category of results other than actuals and in-progress results. Display Name: Custom Rollup Field (Money) |
customrollupfieldmoney_base |
Edm.Decimal |
Description: Indicates a placeholder rollup field for a money value in base currency to track a third category of results other than actuals and in-progress results. Display Name: Custom Rollup Field (Money) (Base) Read-only property |
customrollupfieldstring |
Edm.String |
Description: Placeholder rollup field for the goal. Display Name: Custom Rollup Field Read-only property |
depth |
Edm.Int32 |
Description: Depth of the goal in the tree. Display Name: Depth Read-only property |
entityimage |
Edm.Binary |
Description: The default image for the entity. Display Name: Entity Image |
entityimage_timestamp |
Edm.Int64 |
Description: Read-only property |
entityimage_url |
Edm.String |
Description: Read-only property |
entityimageid |
Edm.Guid |
Description: For internal use only. Display Name: Entity Image Id Read-only property |
exchangerate |
Edm.Decimal |
Description: Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency. Display Name: Exchange Rate Read-only property |
fiscalperiod |
Edm.Int32 |
Description: Select the fiscal period for the goal. Default Options: 1 : Quarter 1 Display Name: Fiscal Period |
fiscalyear |
Edm.Int32 |
Description: Select the fiscal year for the goal that's being tracked. Default Options: 2038 : FY2038 Display Name: Fiscal Year |
goalenddate |
Edm.DateTimeOffset |
Description: Enter the date when the goal ends. Display Name: To |
goalid |
Edm.Guid |
Description: Unique identifier of the goal. Display Name: Goal |
goalstartdate |
Edm.DateTimeOffset |
Description: Enter the date and time when the period for tracking the goal begins. Display Name: From |
importsequencenumber |
Edm.Int32 |
Description: Sequence number of the import that created this record. Display Name: Import Sequence Number |
inprogressdecimal |
Edm.Decimal |
Description: Shows the in-progress value (decimal) against the target. This value could contribute to a goal, but is not counted yet as actual. Display Name: In-progress (Decimal) |
inprogressinteger |
Edm.Int32 |
Description: Shows the in-progress value (integer) against the target. This value could contribute to a goal, but is not counted yet as actual. Display Name: In-progress (Integer) |
inprogressmoney |
Edm.Decimal |
Description: Shows the in-progress value (money) against the target. This value could contribute to a goal, but is not counted yet as actual. Display Name: In-progress (Money) |
inprogressmoney_base |
Edm.Decimal |
Description: Shows the in-progress value (money) in base currency to track goal results against the target. Display Name: In-progress (Money) (Base) Read-only property |
inprogressstring |
Edm.String |
Description: In-progress value of the goal. Display Name: In-Progress Read-only property |
isamount |
Edm.Boolean |
Description: Indicates whether the metric type is Count or Amount. Default Options: 1 : Amount Display Name: Metric Type |
isfiscalperiodgoal |
Edm.Boolean |
Description: Select whether the goal period is a fiscal period or custom period. Default Options: 1 : Fiscal Period Display Name: Goal Period Type |
isoverridden |
Edm.Boolean |
Description: Select whether the system rollup fields are updated. If set to Yes, the next system rollup will not update the values of the rollup fields with the system calculated values. Default Options: 1 : Yes Display Name: Overridden |
isoverride |
Edm.Boolean |
Description: Indicates whether the values of system rollup fields can be updated. Default Options: 1 : Yes Display Name: Override |
lastrolledupdate |
Edm.DateTimeOffset |
Description: Shows the date and time when the goal was last rolled up. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options. Display Name: Last Rolled Up Date |
modifiedon |
Edm.DateTimeOffset |
Description: Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options. Display Name: Modified On Read-only property |
overriddencreatedon |
Edm.DateTimeOffset |
Description: Date and time that the record was migrated. Display Name: Record Created On |
percentage |
Edm.Decimal |
Description: Shows the percentage achieved against the target goal. Display Name: Percentage Achieved |
rolluperrorcode |
Edm.Int32 |
Description: Error code associated with rollup. Display Name: Rollup Error Code |
rolluponlyfromchildgoals |
Edm.Boolean |
Description: Select whether the data should be rolled up only from the child goals. Default Options: 1 : Yes Display Name: Roll Up Only from Child Goals |
statecode |
Edm.Int32 |
Description: Shows whether the goal is open, completed, or canceled. Completed and canceled goals are read-only and can't be edited. Default Options: 0 : Active Display Name: Status |
statuscode |
Edm.Int32 |
Description: Select the goal's status. Default Options: 0 : Open Display Name: Status Reason |
stretchtargetdecimal |
Edm.Decimal |
Description: Select a stretch target (decimal) of the goal to define a higher or difficult level of goal than the usual ones. Display Name: Stretch Target (Decimal) |
stretchtargetinteger |
Edm.Int32 |
Description: Select the stretch target (integer) of the goal to define a higher or difficult level of goal than the usual ones. Display Name: Stretch Target (Integer) |
stretchtargetmoney |
Edm.Decimal |
Description: Select stretch target (money) of the goal to define a higher or difficult level of goal than the usual ones. Display Name: Stretch Target (Money) |
stretchtargetmoney_base |
Edm.Decimal |
Description: Shows the stretch target (money) in base currency to indicate a higher or difficult level of goal than the usual ones. Display Name: Stretch Target (Money) (Base) Read-only property |
stretchtargetstring |
Edm.String |
Description: Stretch target value for all data types. Display Name: Stretched Target Read-only property |
targetdecimal |
Edm.Decimal |
Description: Select a goal target of the decimal type to use for tracking data that include partial numbers, such as pounds sold of a product sold by weight. Display Name: Target (Decimal) |
targetinteger |
Edm.Int32 |
Description: Select a goal target of the integer type to use for tracking anything countable in whole numbers, such as units sold. Display Name: Target (Integer) |
targetmoney |
Edm.Decimal |
Description: Select a goal target (money) to track a monetary amount such as revenue from a product. Display Name: Target (Money) |
targetmoney_base |
Edm.Decimal |
Description: Shows the goal target of the money type in base currency. Display Name: Target (Money) (Base) Read-only property |
targetstring |
Edm.String |
Description: Target value of the goal. Display Name: Target Read-only property |
timezoneruleversionnumber |
Edm.Int32 |
Description: For internal use only. Display Name: Time Zone Rule Version Number |
title |
Edm.String |
Description: Type a title or name that describes the goal. Display Name: Name |
treeid |
Edm.Guid |
Description: Unique identifier of the goal tree. Display Name: Tree ID Read-only property |
utcconversiontimezonecode |
Edm.Int32 |
Description: Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code |
versionnumber |
Edm.Int64 |
Description: Version number of the goal. Display Name: Version Number Read-only property |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced.
| Name | Type | Partner |
|---|---|---|
createdby |
lk_goal_createdby |
|
createdonbehalfby |
lk_goal_createdonbehalfby |
|
goalownerid_systemuser |
user_goal_goalowner |
|
goalownerid_team |
team_goal_goalowner |
|
goalwitherrorid |
Goal_RollupError_Goal |
|
metricid |
metric_goal |
|
modifiedby |
lk_goal_modifiedby |
|
modifiedonbehalfby |
lk_goal_modifiedonbehalfby |
|
ownerid |
owner_goal |
|
owningbusinessunit |
business_unit_goal |
|
owningteam |
team_goal |
|
owninguser |
user_goal |
|
parentgoalid |
goal_parent_goal |
|
rollupqueryactualdecimalid |
goal_rollupquery_actualdecimal |
|
rollupqueryactualintegerid |
goalrollupquery_actualint |
|
rollupqueryactualmoneyid |
goal_rollupquery_actualmoney |
|
rollupquerycustomdecimalid |
goal_rollupquery_customdecimal |
|
rollupquerycustomintegerid |
goal_rollupquery_customint |
|
rollupquerycustommoneyid |
goal_rollupquery_custommoney |
|
rollupqueryinprogressdecimalid |
goal_rollupquery_inprogressdecimal |
|
rollupqueryinprogressintegerid |
goal_rollupquery_inprogressint |
|
rollupqueryinprogressmoneyid |
goal_rollupquery_inprogressmoney |
|
transactioncurrencyid |
TransactionCurrency_Goal |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
Goal_Annotation |
objectid_goal |
|
Goal_AsyncOperations |
regardingobjectid_goal |
|
goal_connections1 |
record1id_goal |
|
goal_connections2 |
record2id_goal |
|
Goal_DuplicateBaseRecord |
baserecordid_goal |
|
Goal_DuplicateMatchingRecord |
duplicaterecordid_goal |
|
goal_parent_goal |
parentgoalid |
|
Goal_RollupError_Goal |
goalwitherrorid |
Operations bound to goal
The following operations are bound to the goal entity type.
| Name | Bound to |
|---|---|
Entity |
Operations using the goal entity type.
The following operations use the goal entity type in a parameter or return type.
| Name | How used | Description |
|---|---|---|
entity Parameter |
Recalculate system-computed values for rollup fields in the goal hierarchy. |
関連項目
他のリソース
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference
Microsoft Dynamics CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.