Back

GET dashboards/{ancestorId}/commitments/{type}?period={period}

Read all commitments for the given ancestor ID. PM

Request Information

URI Parameters

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

ID of the organization.
type string Required

Type of commitment to read; organization, department, or individual.
period integer

ID fo the period for the commitment.

Body Parameters

None.

Response Information

Resource Description (Commitment)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID integer Required on Update

ID of the given commitment.
AncestorID globally unique identifier Required on Create

Ancestor ID (organization, department, or individual) for the given commitment.
Name string Required

Name of the given commitment.
Completed boolean Required

Completed status of the given commitment.
DueDate date Required

Due date of the given commitment.
PeriodID integer Required

ID of the period for the given commitment.
Measure1 string Required

First measure for the given commitment.
Measure1Completed boolean Required

Completed status of the first measure for the given commmitment.
Measure2 string Required

Second measure for the given commitment.
Measure2Completed boolean Required

Completed status of the second measure for the given commmitment.
Measure3 string Required

Third measure for the given commitment.
Measure3Completed boolean Required

Completed status of the third measure for the given commmitment.
Measure4 string Required

Fourth measure for the given commitment.
Measure4Completed boolean Required

Completed status of the fourth measure for the given commmitment.
Measure5 string Required

Fifth measure for the given commitment.
Measure5Completed boolean Required

Completed status of the fifth measure for the given commmitment.
MeasuresCompleted integer ReadOnly

Total number of measures completed for the given commitment.
MeasuresTotal integer ReadOnly

Total number of measures for the given commitment.
AncestorType integer ReadOnly

Ancestor type (organization, department, or individual) for the given commitment.
SiteID globally unique identifier ReadOnly

ID of the site for the given commitment.

Response Formats

application/xml, text/xml

Sample
<Commitment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <AncestorID>e6a01e63-0922-428e-95a7-afbd7f99358e</AncestorID>
  <Name>sample string 3</Name>
  <Completed>true</Completed>
  <DueDate>2024-10-24T07:20:59.4734553+00:00</DueDate>
  <PeriodID>1</PeriodID>
  <Measure1>sample string 5</Measure1>
  <Measure1Completed>true</Measure1Completed>
  <Measure2>sample string 6</Measure2>
  <Measure2Completed>true</Measure2Completed>
  <Measure3>sample string 7</Measure3>
  <Measure3Completed>true</Measure3Completed>
  <Measure4>sample string 8</Measure4>
  <Measure4Completed>true</Measure4Completed>
  <Measure5>sample string 9</Measure5>
  <Measure5Completed>true</Measure5Completed>
  <MeasuresCompleted>1</MeasuresCompleted>
  <MeasuresTotal>1</MeasuresTotal>
  <AncestorType>1</AncestorType>
  <SiteID>5c6829da-655a-4b80-aeb2-1d94a5a137a0</SiteID>
</Commitment>

application/json, text/json

Sample
{
  "ID": 1,
  "AncestorID": "e6a01e63-0922-428e-95a7-afbd7f99358e",
  "Name": "sample string 3",
  "Completed": true,
  "DueDate": "2024-10-24T07:20:59.4734553+00:00",
  "PeriodID": 1,
  "Measure1": "sample string 5",
  "Measure1Completed": true,
  "Measure2": "sample string 6",
  "Measure2Completed": true,
  "Measure3": "sample string 7",
  "Measure3Completed": true,
  "Measure4": "sample string 8",
  "Measure4Completed": true,
  "Measure5": "sample string 9",
  "Measure5Completed": true,
  "MeasuresCompleted": 1,
  "MeasuresTotal": 1,
  "AncestorType": 1,
  "SiteID": "5c6829da-655a-4b80-aeb2-1d94a5a137a0"
}