Create a new metric.
None.
This object takes all the parameters needed to create a new metric.
System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
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 |
<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>8ce3317c-dc49-480f-bbaf-2273e110e958</ID> <ParentID>f67cf3e9-d1e0-4a03-b54e-0b03c8ee4848</ParentID> <AncestorID>7ca1e29d-14c7-4eb8-9efd-fa54ec52fa97</AncestorID> <Rank>1</Rank> <Name>sample string 2</Name> <Description>sample string 3</Description> <Format>sample string 4</Format> <Color>sample string 5</Color> <TColor1>sample string 6</TColor1> <TColor2>sample string 7</TColor2> <TColor3>sample string 8</TColor3> <TColor4>sample string 9</TColor4> <Threshold1>1</Threshold1> <Threshold2>1</Threshold2> <Threshold3>1</Threshold3> <ColorByValue>true</ColorByValue> <Is8020>true</Is8020> <FormattedThreshold1>sample string 17</FormattedThreshold1> <FormattedThreshold2>sample string 18</FormattedThreshold2> <FormattedThreshold3>sample string 19</FormattedThreshold3> <FormattedLatestValue>sample string 20</FormattedLatestValue> <LastComment>sample string 21</LastComment> <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2024-04-11T06:33:38.6851622Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LastCommentDate> <LastCommentByID>e65c6e04-370f-488f-a504-d2485931ebe8</LastCommentByID> <LastCommentBy>sample string 22</LastCommentBy> <DisplayColorName>sample string 23</DisplayColorName> <ColorName>sample string 24</ColorName> <OwnerList> <MetricOwner> <MetricID>59bdc525-ef34-4481-8d34-6119fedef6fb</MetricID> <IndividualID>d17f93fb-c0e5-40c6-878c-e9ad4ba16260</IndividualID> </MetricOwner> <MetricOwner> <MetricID>59bdc525-ef34-4481-8d34-6119fedef6fb</MetricID> <IndividualID>d17f93fb-c0e5-40c6-878c-e9ad4ba16260</IndividualID> </MetricOwner> </OwnerList> <RollUp>25</RollUp> <LinkedToID>ee7e2c8d-fe5b-4965-b1d2-36cac83d949d</LinkedToID> </Metric>
{"ID":"8ce3317c-dc49-480f-bbaf-2273e110e958","ParentID":"f67cf3e9-d1e0-4a03-b54e-0b03c8ee4848","AncestorID":"7ca1e29d-14c7-4eb8-9efd-fa54ec52fa97","Rank":1,"Name":"sample string 2","Description":"sample string 3","Format":"sample string 4","Color":"sample string 5","TColor1":"sample string 6","TColor2":"sample string 7","TColor3":"sample string 8","TColor4":"sample string 9","Threshold1":1.0,"Threshold2":1.0,"Threshold3":1.0,"ColorByValue":true,"Is8020":true,"FormattedThreshold1":"sample string 17","FormattedThreshold2":"sample string 18","FormattedThreshold3":"sample string 19","FormattedLatestValue":"sample string 20","LastComment":"sample string 21","LastCommentDate":"2024-04-11T06:33:38.6851622+00:00","LastCommentByID":"e65c6e04-370f-488f-a504-d2485931ebe8","LastCommentBy":"sample string 22","DisplayColorName":"sample string 23","ColorName":"sample string 24","OwnerList":[{"MetricID":"59bdc525-ef34-4481-8d34-6119fedef6fb","IndividualID":"d17f93fb-c0e5-40c6-878c-e9ad4ba16260","IndividualID":"d17f93fb-c0e5-40c6-878c-e9ad4ba16260","RollUp":25,"LinkedToID":"ee7e2c8d-fe5b-4965-b1d2-36cac83d949d"}
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 |
<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>cc1f51ff-911f-4670-9fc0-a22f55e92ab8</ID> <ParentID>bceb8c0d-74cb-43da-834d-a8cc791f0bcc</ParentID> <AncestorID>c84d6069-7e0b-404f-ab0b-9fbcbeea444f</AncestorID> <Rank>1</Rank> <Name>sample string 2</Name> <Description>sample string 3</Description> <Format>sample string 4</Format> <Color>sample string 5</Color> <TColor1>sample string 6</TColor1> <TColor2>sample string 7</TColor2> <TColor3>sample string 8</TColor3> <TColor4>sample string 9</TColor4> <Threshold1>1</Threshold1> <Threshold2>1</Threshold2> <Threshold3>1</Threshold3> <ColorByValue>true</ColorByValue> <Is8020>true</Is8020> <SiteID>0c48a9c1-0101-4422-ac3f-3f27e24198ad</SiteID> <AncestorType>1</AncestorType> <AncestorName>sample string 10</AncestorName> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Level>1</Level> <DisplayRank>sample string 11</DisplayRank> <RankPath>QEA=</RankPath> <RankOrder>sample string 12</RankOrder> <Created>2024-04-11T06:33:38.7945419+00:00</Created> <CreatedBy>af40c814-710c-4a17-b2be-579a71cb8134</CreatedBy> <Updated>2024-04-11T06:33:38.7945419+00:00</Updated> <UpdatedBy>f3110518-f6b9-40e9-99a4-763c917a075b</UpdatedBy> <DisplayColor>sample string 13</DisplayColor> <DisplayColorRank>1</DisplayColorRank> <LatestDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2024-04-11T06:33:38.7945419Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LatestDate> <LatestValue>1</LatestValue> <LatestValueColor>sample string 14</LatestValueColor> <LatestComment>sample string 15</LatestComment> <Owners>sample string 16</Owners> <FormattedThreshold1>sample string 17</FormattedThreshold1> <FormattedThreshold2>sample string 18</FormattedThreshold2> <FormattedThreshold3>sample string 19</FormattedThreshold3> <FormattedLatestValue>sample string 20</FormattedLatestValue> <LastComment>sample string 21</LastComment> <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2024-04-11T06:33:38.7945419Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LastCommentDate> <LastCommentByID>fce59ab2-bcbf-4a77-b7ab-28713f535f9f</LastCommentByID> <LastCommentBy>sample string 22</LastCommentBy> <DisplayColorName>sample string 23</DisplayColorName> <CanRead>true</CanRead> <CanUpdate>true</CanUpdate> <CanDelete>true</CanDelete> <CanDelegate>true</CanDelegate> <ColorRank>1</ColorRank> <ColorName>sample string 24</ColorName> <OwnerList> <MetricOwner> <MetricID>e39d4950-6d10-4344-bac9-3b54b36a42ef</MetricID> <IndividualID>0e52ade6-b493-46f9-86c6-335f32dde29d</IndividualID> <ID>d7b45861-1720-41bc-b820-af5ba194c777</ID> <MetricName>sample string 1</MetricName> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <FullName>sample string 4</FullName> <Email>sample string 5</Email> <SiteID>1f0b69a3-2b76-4c24-94a5-0bacb2b6f5e1</SiteID> </MetricOwner> <MetricOwner> <MetricID>e39d4950-6d10-4344-bac9-3b54b36a42ef</MetricID> <IndividualID>0e52ade6-b493-46f9-86c6-335f32dde29d</IndividualID> <ID>d7b45861-1720-41bc-b820-af5ba194c777</ID> <MetricName>sample string 1</MetricName> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <FullName>sample string 4</FullName> <Email>sample string 5</Email> <SiteID>1f0b69a3-2b76-4c24-94a5-0bacb2b6f5e1</SiteID> </MetricOwner> </OwnerList> <RollUp>25</RollUp> <LinkedToID>7fa66f96-0bc5-43b4-8834-34c21e3d3491</LinkedToID> </Metric>
{ "ID": "cc1f51ff-911f-4670-9fc0-a22f55e92ab8", "ParentID": "bceb8c0d-74cb-43da-834d-a8cc791f0bcc", "AncestorID": "c84d6069-7e0b-404f-ab0b-9fbcbeea444f", "Rank": 1, "Name": "sample string 2", "Description": "sample string 3", "Format": "sample string 4", "Color": "sample string 5", "TColor1": "sample string 6", "TColor2": "sample string 7", "TColor3": "sample string 8", "TColor4": "sample string 9", "Threshold1": 1.0, "Threshold2": 1.0, "Threshold3": 1.0, "ColorByValue": true, "Is8020": true, "SiteID": "0c48a9c1-0101-4422-ac3f-3f27e24198ad", "AncestorType": 1, "AncestorName": "sample string 10", "Deleted": true, "DeletedByRef": true, "Level": 1, "DisplayRank": "sample string 11", "RankPath": "QEA=", "RankOrder": "sample string 12", "Created": "2024-04-11T06:33:38.7945419+00:00", "CreatedBy": "af40c814-710c-4a17-b2be-579a71cb8134", "Updated": "2024-04-11T06:33:38.7945419+00:00", "UpdatedBy": "f3110518-f6b9-40e9-99a4-763c917a075b", "DisplayColor": "sample string 13", "DisplayColorRank": 1, "LatestDate": "2024-04-11T06:33:38.7945419+00:00", "LatestValue": 1.0, "LatestValueColor": "sample string 14", "LatestComment": "sample string 15", "Owners": "sample string 16", "FormattedThreshold1": "sample string 17", "FormattedThreshold2": "sample string 18", "FormattedThreshold3": "sample string 19", "FormattedLatestValue": "sample string 20", "LastComment": "sample string 21", "LastCommentDate": "2024-04-11T06:33:38.7945419+00:00", "LastCommentByID": "fce59ab2-bcbf-4a77-b7ab-28713f535f9f", "LastCommentBy": "sample string 22", "DisplayColorName": "sample string 23", "CanRead": true, "CanUpdate": true, "CanDelete": true, "CanDelegate": true, "ColorRank": 1, "ColorName": "sample string 24", "OwnerList": [ { "MetricID": "e39d4950-6d10-4344-bac9-3b54b36a42ef", "IndividualID": "0e52ade6-b493-46f9-86c6-335f32dde29d", "ID": "d7b45861-1720-41bc-b820-af5ba194c777", "MetricName": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "FullName": "sample string 4", "Email": "sample string 5", "SiteID": "1f0b69a3-2b76-4c24-94a5-0bacb2b6f5e1" }, { "MetricID": "e39d4950-6d10-4344-bac9-3b54b36a42ef", "IndividualID": "0e52ade6-b493-46f9-86c6-335f32dde29d", "ID": "d7b45861-1720-41bc-b820-af5ba194c777", "MetricName": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "FullName": "sample string 4", "Email": "sample string 5", "SiteID": "1f0b69a3-2b76-4c24-94a5-0bacb2b6f5e1" } ], "RollUp": 25, "LinkedToID": "7fa66f96-0bc5-43b4-8834-34c21e3d3491" }