Goal Metric (Metric) table/entity reference

Article
08/31/2024

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

Messages

The following table lists the messages for the Goal Metric (Metric) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Create` Event: True	`POST` /metrics See Create	Create records
`Delete` Event: True	`DELETE` /metrics(metricid) See Delete	Delete records
`Retrieve` Event: True	`GET` /metrics(metricid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /metrics See Query data	Query data
`SetState` Event: True	`PATCH` /metrics(metricid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /metrics(metricid) See Update	Update records
`Upsert` Event: False	`PATCH` /metrics(metricid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Goal Metric (Metric) table.

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

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
LogicalName	`amountdatatype`
RequiredLevel	None
Type	Picklist
DefaultFormValue
GlobalChoiceName	`metric_goaltype`

AmountDataType Choices/Options

Value	Label
0	Money
1	Decimal
2	Integer

Description

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

ImportSequenceNumber

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

IsAmount

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

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
GlobalChoiceName	`metric_trackstretchtarget`
DefaultValue	False
True Label	Yes
False Label	No

MetricId

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

Name

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

OverriddenCreatedOn

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

StateCode

Property	Value
Description	Status of the goal metric.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`metric_statecode`

StateCode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 0 InvariantName: `Active`
1	Label: Inactive DefaultStatus: 1 InvariantName: `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
DefaultFormValue
GlobalChoiceName	`metric_statuscode`

StatusCode Choices/Options

Value	Details
0	Label: Open State:0 TransitionData: None
1	Label: Closed State:1 TransitionData: None

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

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

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
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
Type	Lookup
Targets	systemuser

CreatedOn

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

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
Type	Lookup
Targets	systemuser

ModifiedBy

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

ModifiedOn

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

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
Type	Lookup
Targets	systemuser

OrganizationId

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

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

lk_metric_createdby
lk_metric_createdonbehalfby
lk_metric_modifiedby
lk_metric_modifiedonbehalfby
organization_metric

lk_metric_createdby

One-To-Many Relationship: systemuser lk_metric_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_metric_createdonbehalfby

One-To-Many Relationship: systemuser lk_metric_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_metric_modifiedby

One-To-Many Relationship: systemuser lk_metric_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_metric_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_metric_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

organization_metric

One-To-Many Relationship: organization organization_metric

Property	Value
ReferencedEntity	`organization`
ReferencedAttribute	`organizationid`
ReferencingAttribute	`organizationid`
ReferencingEntityNavigationPropertyName	`organizationid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

metric_AsyncOperations
metric_goal
metric_ProcessSessions
metric_rollupfield
Metric_SyncErrors

metric_AsyncOperations

Many-To-One Relationship: asyncoperation metric_AsyncOperations

Property	Value
ReferencingEntity	`asyncoperation`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`metric_AsyncOperations`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

metric_goal

Many-To-One Relationship: goal metric_goal

Property	Value
ReferencingEntity	`goal`
ReferencingAttribute	`metricid`
ReferencedEntityNavigationPropertyName	`metric_goal`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 110 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

metric_ProcessSessions

Many-To-One Relationship: processsession metric_ProcessSessions

Property	Value
ReferencingEntity	`processsession`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`metric_ProcessSessions`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 110 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

metric_rollupfield

Many-To-One Relationship: rollupfield metric_rollupfield

Property	Value
ReferencingEntity	`rollupfield`
ReferencingAttribute	`metricid`
ReferencedEntityNavigationPropertyName	`metric_rollupfield`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 120 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Metric_SyncErrors

Many-To-One Relationship: syncerror Metric_SyncErrors

Property	Value
ReferencingEntity	`syncerror`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`Metric_SyncErrors`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Share via