Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id globally unique identifier Required

Guid ID of the organization, department or individual for the project.

metricType string Required

Type of metric to filter by; below, min, meets, exceeds, 8020, 8020dept.

period integer

Optional period ID filter. Defaults to the current period.

Body Parameters

None.

Response Information

Resource Description (MetricPM)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier ReadOnly

ID of the given metric.

RowType integer ReadOnly

RowType of the given metric.

Name string ReadOnly

Name of the given metric.

AncestorID globally unique identifier ReadOnly

Ancestor ID of the given metric.

Color string ReadOnly

Color of the given metric.

ColorRank integer ReadOnly

Rank of the color for the given metric.

ColorName string ReadOnly

Name of the color for the given metric.

Format string ReadOnly

Format of the given metric.

Minimum decimal number ReadOnly

Minimum value that meets the expecations of the given metric.

Meets decimal number ReadOnly

Value that meets the expectations of the given metric.

Exceeds decimal number ReadOnly

Value that exceeds the expectations of the given metric.

Current decimal number ReadOnly

Current value of the given metric.

CurrentDate date ReadOnly

Current date of the given metric.

FormattedMinimum string ReadOnly

Minimum value of the given metric formatted using the Format value.

FormattedMeets string ReadOnly

Meets value of the given metric formatted using the Format value.

FormattedExceeds string ReadOnly

Exceeds value of the given metric formatted using the Format value.

FormattedCurrent string ReadOnly

Current value of the given metric formatted using the Format value.

ThresholdLevel integer ReadOnly

Current thresholdlevel of the given metric.

Response Formats

application/xml, text/xml

Sample
<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>93ee9393-1d76-4c77-acda-c59bd53e73ea</ID>
  <RowType>2</RowType>
  <Name>sample string 3</Name>
  <AncestorID>cb258594-29ca-4d60-a0a0-1e468e1046af</AncestorID>
  <Color>sample string 5</Color>
  <ColorRank>1</ColorRank>
  <ColorName>sample string 6</ColorName>
  <Format>sample string 7</Format>
  <Minimum>1</Minimum>
  <Meets>1</Meets>
  <Exceeds>1</Exceeds>
  <Current>1</Current>
  <CurrentDate>2021-11-03T18:56:21.2812839+00:00</CurrentDate>
  <FormattedCurrent>sample string 11</FormattedCurrent>
  <FormattedExceeds>sample string 10</FormattedExceeds>
  <FormattedMeets>sample string 9</FormattedMeets>
  <FormattedMinimum>sample string 8</FormattedMinimum>
  <ThresholdLevel>1</ThresholdLevel>
</Metric>

application/json, text/json

Sample
{
  "ID": "93ee9393-1d76-4c77-acda-c59bd53e73ea",
  "RowType": 2,
  "Name": "sample string 3",
  "AncestorID": "cb258594-29ca-4d60-a0a0-1e468e1046af",
  "Color": "sample string 5",
  "ColorRank": 1,
  "ColorName": "sample string 6",
  "Format": "sample string 7",
  "Minimum": 1.0,
  "Meets": 1.0,
  "Exceeds": 1.0,
  "Current": 1.0,
  "CurrentDate": "2021-11-03T18:56:21.2812839+00:00",
  "FormattedMinimum": "sample string 8",
  "FormattedMeets": "sample string 9",
  "FormattedExceeds": "sample string 10",
  "FormattedCurrent": "sample string 11",
  "ThresholdLevel": 1
}