metric EntityType
Type of measurement for a goal, such as money amount or count.
- Entity set path:
- [organization URI]/api/data/v9.2/metrics
- Base type:
- crmbaseentity
- Display name:
- Goal Metric
- Primary key:
- metricid
- Primary key attribute:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| amountdatatype | Edm.Int32 |
Data type of the amount. Display name: Amount Data Type
Default options
|
||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||
| description | Edm.String |
Description of the goal metric. Display name: Description |
||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||
| isamount | Edm.Boolean |
Information that indicates whether the metric type is Count or Amount. Display name: Metric Type
Default options
|
||||||||
| isstretchtracked | Edm.Boolean |
Indicates whether the goal metric tracks stretch targets. Display name: Track Stretch Target
Default options
|
||||||||
| metricid | Edm.Guid |
Unique identifier of the goal metric. Display name: Goal Metric |
||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||
| name | Edm.String |
Name of the goal metric. Display name: Name |
||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||
| statecode | Edm.Int32 |
Status of the goal metric. Display name: Status
Default options
|
||||||||
| statuscode | Edm.Int32 |
Reason for the status of the goal metric. Display name: Status Reason
Default options
|
||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||
| versionnumber | Edm.Int64 |
Version number of the goal metric. Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _organizationid_value | organizationid |
Unique identifier of the organization. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_metric_createdby |
| createdonbehalfby | systemuser | lk_metric_createdonbehalfby |
| modifiedby | systemuser | lk_metric_modifiedby |
| modifiedonbehalfby | systemuser | lk_metric_modifiedonbehalfby |
| organizationid | organization | organization_metric |
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 |
|---|---|---|
| metric_AsyncOperations | asyncoperation | regardingobjectid_metric |
| metric_goal | goal | metricid |
| metric_ProcessSessions | processsession | regardingobjectid_metric |
| metric_rollupfield | rollupfield | metricid |
| Metric_SyncErrors | syncerror | regardingobjectid_metric_syncerror |