Goal Metric (Metric) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Type of measurement for a goal, such as money amount or count.

Messages

Message	Web API Operation	SDK class or method
Create	POST /metrics See Create	CreateRequest or Create
Delete	DELETE /metrics(metricid) See Delete	DeleteRequest or Delete
Retrieve	GET /metrics(metricid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET /metrics See Query Data	RetrieveMultipleRequest or RetrieveMultiple
SetState	PATCH /metrics(metricid) Update statecode and statuscode properties.	SetStateRequest
Update	PATCH /metrics(metricid) See Update	UpdateRequest or Update

Properties

Property	Value
CollectionSchemaName	Metrics
DisplayCollectionName	Goal Metrics
DisplayName	Goal Metric
EntitySetName	metrics
IsBPFEntity	False
LogicalCollectionName	metrics
LogicalName	metric
OwnershipType	OrganizationOwned
PrimaryIdAttribute	metricid
PrimaryNameAttribute	name
SchemaName	Metric

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• AmountDataType
• Description
• ImportSequenceNumber
• IsAmount
• IsStretchTracked
• MetricId
• Name
• OverriddenCreatedOn
• StateCode
• StatusCode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

AmountDataType

Property	Value
Description	Data type of the amount.
DisplayName	Amount Data Type
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	amountdatatype
RequiredLevel	None
Type	Picklist

AmountDataType Choices/Options

Value	Label	Description
0	Money
1	Decimal
2	Integer

Description

Property	Value
Description	Description of the goal metric.
DisplayName	Description
Format	TextArea
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	description
MaxLength	2000
RequiredLevel	None
Type	Memo

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
Format	None
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	importsequencenumber
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

IsAmount

Property	Value
Description	Information that indicates whether the metric type is Count or Amount.
DisplayName	Metric Type
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	isamount
RequiredLevel	ApplicationRequired
Type	Boolean

IsAmount Choices/Options

Value	Label	Description
1	Amount
0	Count

DefaultValue: 1

IsStretchTracked

Property	Value
Description	Indicates whether the goal metric tracks stretch targets.
DisplayName	Track Stretch Target
IsValidForForm	True
IsValidForRead	True
LogicalName	isstretchtracked
RequiredLevel	None
Type	Boolean

IsStretchTracked Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

MetricId

Property	Value
Description	Unique identifier of the goal metric.
DisplayName	Goal Metric
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	metricid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

Name

Property	Value
Description	Name of the goal metric.
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

OverriddenCreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time that the record was migrated.
DisplayName	Record Created On
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime

StateCode

Property	Value
Description	Status of the goal metric.
DisplayName	Status
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

StateCode Choices/Options

Value	Label	DefaultStatus	InvariantName
0	Active	0	Active
1	Inactive	1	Inactive

StatusCode

Property	Value
Description	Reason for the status of the goal metric.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

StatusCode Choices/Options

Value	Label	State
0	Open	0
1	Closed	1

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• CreatedBy
• CreatedByName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OrganizationId
• OrganizationIdName
• VersionNumber

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

OrganizationId

Property	Value
Description	Unique identifier of the organization.
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	None
Targets	organization
Type	Lookup

OrganizationIdName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationidname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

VersionNumber

Property	Value
Description	Version number of the goal metric.
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

One-To-Many Relationships

Listed by SchemaName.

• metric_goal
• metric_rollupfield
• msdyn_metric_msdyn_forecastdefinition_metricid

metric_goal

Same as the metric_goal many-to-one relationship for the goal table/entity.

Property	Value
ReferencingEntity	goal
ReferencingAttribute	metricid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	metric_goal
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order: 110
CascadeConfiguration	Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

metric_rollupfield

Same as the metric_rollupfield many-to-one relationship for the rollupfield table/entity.

Property	Value
ReferencingEntity	rollupfield
ReferencingAttribute	metricid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	metric_rollupfield
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order: 120
CascadeConfiguration	Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

msdyn_metric_msdyn_forecastdefinition_metricid

Added by: Forecasting Solution

Same as the msdyn_metric_msdyn_forecastdefinition_metricid many-to-one relationship for the msdyn_forecastdefinition table/entity.

Property	Value
ReferencingEntity	msdyn_forecastdefinition
ReferencingAttribute	msdyn_metricid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	msdyn_metric_msdyn_forecastdefinition_metricid
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order: 10000
CascadeConfiguration	Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

Related information

Dataverse table/entity reference
Web API Reference