POST metrics

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

None.

Body Parameters (Metric)

This object takes all the parameters needed to create a new metric.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Request Formats

application/xml, text/xml

Sample

<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>5853e003-bfc6-4788-a3d2-af4e92c9970d</ID>
  <ParentID>1977a3e5-9f56-4b66-8b62-23a4a28b5cfe</ParentID>
  <AncestorID>828c81c7-1216-4dc2-a2a8-2199ef8f564e</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>2025-04-10T17:16:42.1610007Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>68bab992-9556-44d2-b977-5504dd33e499</LastCommentByID>
  <LastCommentBy>sample string 22</LastCommentBy>
  <DisplayColorName>sample string 23</DisplayColorName>
  <ColorName>sample string 24</ColorName>
  <OwnerList>
    <MetricOwner>
      <MetricID>0ee7b48b-63f3-446d-8057-eef897f08fa7</MetricID>
      <IndividualID>afbf1e63-ae84-4c1a-8f3a-bb2f13f4363d</IndividualID>
    </MetricOwner>
    <MetricOwner>
      <MetricID>0ee7b48b-63f3-446d-8057-eef897f08fa7</MetricID>
      <IndividualID>afbf1e63-ae84-4c1a-8f3a-bb2f13f4363d</IndividualID>
    </MetricOwner>
  </OwnerList>
  <RollUp>25</RollUp>
  <LinkedToID>284eec4b-2095-43b5-ad5e-ee06ed5e562e</LinkedToID>
</Metric>

application/json, text/json

Sample

{"ID":"5853e003-bfc6-4788-a3d2-af4e92c9970d","ParentID":"1977a3e5-9f56-4b66-8b62-23a4a28b5cfe","AncestorID":"828c81c7-1216-4dc2-a2a8-2199ef8f564e","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":"2025-04-10T17:16:42.1610007+00:00","LastCommentByID":"68bab992-9556-44d2-b977-5504dd33e499","LastCommentBy":"sample string 22","DisplayColorName":"sample string 23","ColorName":"sample string 24","OwnerList":[{"MetricID":"0ee7b48b-63f3-446d-8057-eef897f08fa7","IndividualID":"afbf1e63-ae84-4c1a-8f3a-bb2f13f4363d","IndividualID":"afbf1e63-ae84-4c1a-8f3a-bb2f13f4363d","RollUp":25,"LinkedToID":"284eec4b-2095-43b5-ad5e-ee06ed5e562e"}

Response Information

Resource Description (Metric)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Response Formats

application/xml, text/xml

Sample

<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>f4737611-69c2-4f39-af3d-efd458258b86</ID>
  <ParentID>4a30217f-700d-4345-86f3-6ac71589b164</ParentID>
  <AncestorID>c09d2785-38f5-467f-b5ea-2af7931c207d</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>69ff87b2-facf-4227-87da-337c63cf8d37</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>2025-04-10T17:16:42.1713072+00:00</Created>
  <CreatedBy>eb77817c-39d8-4d0d-89b8-5727dfdec813</CreatedBy>
  <Updated>2025-04-10T17:16:42.1713072+00:00</Updated>
  <UpdatedBy>19d147f7-8160-4709-94d4-362f7e856a40</UpdatedBy>
  <DisplayColor>sample string 13</DisplayColor>
  <DisplayColorRank>1</DisplayColorRank>
  <LatestDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-10T17:16:42.1713072Z</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>2025-04-10T17:16:42.1713072Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>ef05e986-fc67-4d9d-b80a-d050e867e68f</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>d8f920dd-ec95-41d6-85b5-375d6a188c8e</MetricID>
      <IndividualID>6947f73c-39ac-4576-a4fa-b361d3bbdab9</IndividualID>
      <ID>2d99c4cb-8614-4d54-b004-59ea04a1b15a</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>362088fd-c6c1-46fd-85be-a107e3152b82</SiteID>
    </MetricOwner>
    <MetricOwner>
      <MetricID>d8f920dd-ec95-41d6-85b5-375d6a188c8e</MetricID>
      <IndividualID>6947f73c-39ac-4576-a4fa-b361d3bbdab9</IndividualID>
      <ID>2d99c4cb-8614-4d54-b004-59ea04a1b15a</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>362088fd-c6c1-46fd-85be-a107e3152b82</SiteID>
    </MetricOwner>
  </OwnerList>
  <RollUp>25</RollUp>
  <LinkedToID>05922758-2b66-43f8-a6dd-96a17c8af18c</LinkedToID>
</Metric>

application/json, text/json

Sample

{
  "ID": "f4737611-69c2-4f39-af3d-efd458258b86",
  "ParentID": "4a30217f-700d-4345-86f3-6ac71589b164",
  "AncestorID": "c09d2785-38f5-467f-b5ea-2af7931c207d",
  "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": "69ff87b2-facf-4227-87da-337c63cf8d37",
  "AncestorType": 1,
  "AncestorName": "sample string 10",
  "Deleted": true,
  "DeletedByRef": true,
  "Level": 1,
  "DisplayRank": "sample string 11",
  "RankPath": "QEA=",
  "RankOrder": "sample string 12",
  "Created": "2025-04-10T17:16:42.1713072+00:00",
  "CreatedBy": "eb77817c-39d8-4d0d-89b8-5727dfdec813",
  "Updated": "2025-04-10T17:16:42.1713072+00:00",
  "UpdatedBy": "19d147f7-8160-4709-94d4-362f7e856a40",
  "DisplayColor": "sample string 13",
  "DisplayColorRank": 1,
  "LatestDate": "2025-04-10T17:16:42.1713072+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": "2025-04-10T17:16:42.1713072+00:00",
  "LastCommentByID": "ef05e986-fc67-4d9d-b80a-d050e867e68f",
  "LastCommentBy": "sample string 22",
  "DisplayColorName": "sample string 23",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true,
  "ColorRank": 1,
  "ColorName": "sample string 24",
  "OwnerList": [
    {
      "MetricID": "d8f920dd-ec95-41d6-85b5-375d6a188c8e",
      "IndividualID": "6947f73c-39ac-4576-a4fa-b361d3bbdab9",
      "ID": "2d99c4cb-8614-4d54-b004-59ea04a1b15a",
      "MetricName": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "Email": "sample string 5",
      "SiteID": "362088fd-c6c1-46fd-85be-a107e3152b82"
    },
    {
      "MetricID": "d8f920dd-ec95-41d6-85b5-375d6a188c8e",
      "IndividualID": "6947f73c-39ac-4576-a4fa-b361d3bbdab9",
      "ID": "2d99c4cb-8614-4d54-b004-59ea04a1b15a",
      "MetricName": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "Email": "sample string 5",
      "SiteID": "362088fd-c6c1-46fd-85be-a107e3152b82"
    }
  ],
  "RollUp": 25,
  "LinkedToID": "05922758-2b66-43f8-a6dd-96a17c8af18c"
}

Name	Description
ID `globally unique identifier` Required on Update ID of the given metric.	`globally unique identifier` Required on Update ID of the given metric.
ParentID `globally unique identifier` ID of the parent for the given metric.	`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.	`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.	`integer` Required Rank of the given metric.
Name `string` Required Name of the given metric. (Max length 255 characters)	`string` Required Name of the given metric. (Max length 255 characters)
Description `string` Required Description of the given metric.	`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.#')	`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.	`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)	`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)	`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)	`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)	`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.	`decimal number` First Threshold of the given metric.
Threshold2 `decimal number` Second threshold of the given metric.	`decimal number` Second threshold of the given metric.
Threshold3 `decimal number` Third threshold of the given metric.	`decimal number` Third threshold of the given metric.
ColorByValue `boolean` Color of the given metric.	`boolean` Color of the given metric.
Is8020 `boolean` 80/20 setting of the given metric.	`boolean` 80/20 setting of the given metric.
SiteID `globally unique identifier` ReadOnly ID of the site for the given metric.	`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.	`integer` ReadOnly Type of the ancestor for the metric; organization, project, or individual.
AncestorName `string` ReadOnly Name of the ancestor for the given metric.	`string` ReadOnly Name of the ancestor for the given metric.
Deleted `boolean` ReadOnly Deleted status of the given metric.	`boolean` ReadOnly Deleted status of the given metric.
DeletedByRef `boolean` ReadOnly Deleted by Ref status of the given metric.	`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	`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.	`string` ReadOnly Rank that is displayed to the user.
RankPath `Collection of byte` ReadOnly Current rank of the given metric in a byte array.	`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.	`string` ReadOnly Rank in string format, (0001.0001.0001) for the given organization/department.
Created `date` ReadOnly Date the given metric was created.	`date` ReadOnly Date the given metric was created.
CreatedBy `globally unique identifier` ReadOnly ID of the individual who created the given metric.	`globally unique identifier` ReadOnly ID of the individual who created the given metric.
Updated `date` ReadOnly Date the given metric was updated.	`date` ReadOnly Date the given metric was updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the individual who updated the given metric.	`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.	`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.	`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.	`date` ReadOnly Latest date a value was entered for the given metric.
LatestValue `decimal number` ReadOnly Latest value of the given metric.	`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.	`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.	`string` ReadOnly (Deprecated, replaced with LastComment) Latest comment of the metric.
Owners `string` ReadOnly Owners of the given metric.	`string` ReadOnly Owners of the given metric.
FormattedThreshold1 `string` ReadOnly Minimum threshold of the given metric, formatted using the Format value.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`integer` ReadOnly Rank of the color assigned to the given metric.
ColorName `string` ReadOnly Name of the color to assigned to the given metric.	`string` ReadOnly Name of the color to assigned to the given metric.
OwnerList `Collection of MetricOwner` ReadOnly	`Collection of MetricOwner` ReadOnly
RollUp `integer` ReadOnly Roll up status of a metric. 0 = Normal, 1 = Sum Roll up, 3 = Average Roll up	`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	`globally unique identifier` ReadOnly ID of the Linked Metric