|
ID
globally unique identifier
Required on Update
ID of the given metric. |
|
ParentID
globally unique identifier
ID of the parent for the given metric. |
|
AncestorID
globally unique identifier
Required on Create
ID of the ancestor for the given metric; organization, department, project, or individual. |
|
Rank
integer
Required
Rank of the given metric. |
|
Name
string
Required
Name of the given metric. (Max length 255 characters) |
|
Description
string
Required
Description of the given metric. |
|
Format
string
Format of the number for the trend value. Examples can be found https://connectionsonline.zendesk.com/entries/21843291-Formatting-Metric-Examples. (Max length 255 characters, Default '0.#') |
|
Color
string
Hex value of the color for the given metric. |
|
TColor1
string
First threshold hex value of the color for the given metric. (Max length 6 characters) |
|
TColor2
string
Second threshold hex value of the color for the given metric. (Max length 6 characters) |
|
TColor3
string
Third threshold hex value of the color for the given metric. (Max length 6 characters) |
|
TColor4
string
Fourth threshold hex value of the color for the given metric. (Max length 6 characters) |
|
Threshold1
decimal number
First Threshold of the given metric. |
|
Threshold2
decimal number
Second threshold of the given metric. |
|
Threshold3
decimal number
Third threshold of the given metric. |
|
ColorByValue
boolean
Color of the given metric. |
|
Is8020
boolean
80/20 setting of the given metric. |
|
SiteID
globally unique identifier
ReadOnly
ID of the site for the given metric. |
|
AncestorType
integer
ReadOnly
Type of the ancestor for the metric; organization, project, or individual. |
|
AncestorName
string
ReadOnly
Name of the ancestor for the given metric. |
|
Deleted
boolean
ReadOnly
Deleted status of the given metric. |
|
DeletedByRef
boolean
ReadOnly
Deleted by Ref status of the given metric. |
|
Level
integer
ReadOnly
Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3 |
|
DisplayRank
string
ReadOnly
Rank that is displayed to the user. |
|
RankPath
Collection of byte
ReadOnly
Current rank of the given metric in a byte array. |
|
RankOrder
string
ReadOnly
Rank in string format, (0001.0001.0001) for the given organization/department. |
|
Created
date
ReadOnly
Date the given metric was created. |
|
CreatedBy
globally unique identifier
ReadOnly
ID of the individual who created the given metric. |
|
Updated
date
ReadOnly
Date the given metric was updated. |
|
UpdatedBy
globally unique identifier
ReadOnly
ID of the individual who updated the given metric. |
|
DisplayColor
string
ReadOnly
Display color hex value entered for the given metric. |
|
DisplayColorRank
integer
ReadOnly
Rank of the display color for the given metric. Based on either the current value/threshold or the custom entered color. |
|
LatestDate
date
ReadOnly
Latest date a value was entered for the given metric. |
|
LatestValue
decimal number
ReadOnly
Latest value of the given metric. |
|
LatestValueColor
string
ReadOnly
Latest color hex value for the given metric, based on the current value. |
|
LatestComment
string
ReadOnly
(Deprecated, replaced with LastComment) Latest comment of the metric. |
|
Owners
string
ReadOnly
Owners of the given metric. |
|
FormattedThreshold1
string
ReadOnly
Minimum threshold of the given metric, formatted using the Format value. |
|
FormattedThreshold2
string
ReadOnly
Meets threshold of the given metric, formatted using the Format value. |
|
FormattedThreshold3
string
ReadOnly
Exceeds threshold of the given metric, formatted using the Format value. |
|
FormattedLatestValue
string
ReadOnly
Current value of the given metric formatted using the Format value. |
|
LastComment
string
ReadOnly
Body of the most recent comment on the given metric. |
|
LastCommentDate
date
ReadOnly
Post date of the most recent comment on the given metric. |
|
LastCommentByID
globally unique identifier
ReadOnly
User ID of the individual who posted the most recent comment on the given metric. |
|
LastCommentBy
string
ReadOnly
Name of the individual who posted the most recent comment on the given metric. |
|
DisplayColorName
string
ReadOnly
Name of the color to be displayed. |
|
CanRead
boolean
ReadOnly
Read security setting for the object based on the current logged in user. |
|
CanUpdate
boolean
ReadOnly
Update security setting for the object based on the current logged in user. |
|
CanDelete
boolean
ReadOnly
Delete security setting for the object based on the current logged in user. |
|
CanDelegate
boolean
ReadOnly
Delegate security setting for the object based on the current logged in user. |
|
ColorRank
integer
ReadOnly
Rank of the color assigned to the given metric. |
|
ColorName
string
ReadOnly
Name of the color to assigned to the given metric. |
| OwnerList Collection of MetricOwner ReadOnly |
|
RollUp
integer
ReadOnly
Roll up status of a metric. 0 = Normal, 1 = Sum Roll up, 3 = Average Roll up |
|
LinkedToID
globally unique identifier
ReadOnly
ID of the Linked Metric |

