POST goals

Request Information

URI Parameters

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

None.

Body Parameters (Goal)

Contains all the parameters to create a new goal.

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

Request Formats

application/xml, text/xml

Sample

<Goal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <IndividualID>47b36478-f10f-4d14-a098-ad67e461f85e</IndividualID>
  <Name>sample string 3</Name>
  <Completed>true</Completed>
  <Comment>sample string 5</Comment>
  <Why>sample string 6</Why>
  <DueDate>2024-10-24T08:22:40.7996994+00:00</DueDate>
  <PeriodID>7</PeriodID>
  <Measure1>sample string 8</Measure1>
  <Measure1Completed>true</Measure1Completed>
  <Measure1EndDate>2024-10-24T08:22:40.7996994+00:00</Measure1EndDate>
  <Measure1StartDate>2024-10-24T08:22:40.7996994+00:00</Measure1StartDate>
  <Measure2>sample string 9</Measure2>
  <Measure2Completed>true</Measure2Completed>
  <Measure2EndDate>2024-10-24T08:22:40.7996994+00:00</Measure2EndDate>
  <Measure2StartDate>2024-10-24T08:22:40.7996994+00:00</Measure2StartDate>
  <Measure3>sample string 10</Measure3>
  <Measure3Completed>true</Measure3Completed>
  <Measure3EndDate>2024-10-24T08:22:40.7996994+00:00</Measure3EndDate>
  <Measure3StartDate>2024-10-24T08:22:40.7996994+00:00</Measure3StartDate>
  <Measure4>sample string 11</Measure4>
  <Measure4Completed>true</Measure4Completed>
  <Measure4EndDate>2024-10-24T08:22:40.7996994+00:00</Measure4EndDate>
  <Measure4StartDate>2024-10-24T08:22:40.7996994+00:00</Measure4StartDate>
  <Measure5>sample string 12</Measure5>
  <Measure5Completed>true</Measure5Completed>
  <Measure5EndDate>2024-10-24T08:22:40.7996994+00:00</Measure5EndDate>
  <Measure5StartDate>2024-10-24T08:22:40.7996994+00:00</Measure5StartDate>
</Goal>

application/json, text/json

Sample

{","ID":1,"IndividualID":"47b36478-f10f-4d14-a098-ad67e461f85e","Name":"sample string 3","Completed":true,"Comment":"sample string 5","Why":"sample string 6","DueDate":"2024-10-24T08:22:40.7996994+00:00","PeriodID":7,"Measure1":"sample string 8","Measure1Completed":true,"Measure1EndDate":"2024-10-24T08:22:40.7996994+00:00","Measure1StartDate":"2024-10-24T08:22:40.7996994+00:00","Measure2":"sample string 9","Measure2Completed":true,"Measure2EndDate":"2024-10-24T08:22:40.7996994+00:00","Measure2StartDate":"2024-10-24T08:22:40.7996994+00:00","Measure3":"sample string 10","Measure3Completed":true,"Measure3EndDate":"2024-10-24T08:22:40.7996994+00:00","Measure3StartDate":"2024-10-24T08:22:40.7996994+00:00","Measure4":"sample string 11","Measure4Completed":true,"Measure4EndDate":"2024-10-24T08:22:40.7996994+00:00","Measure4StartDate":"2024-10-24T08:22:40.7996994+00:00","Measure5":"sample string 12","Measure5Completed":true,"Measure5EndDate":"2024-10-24T08:22:40.7996994+00:00","Measure5StartDate":"2024-10-24T08:22:40.7996994+00:00"}

Response Information

Resource Description (Goal)

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

Response Formats

application/xml, text/xml

Sample

<Goal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <FullName>sample string 14</FullName>
  <MeasuresCompleted>1</MeasuresCompleted>
  <MeasuresTotal>1</MeasuresTotal>
  <SiteID>05620237-30d2-446b-b771-783dada52720</SiteID>
  <ID>1</ID>
  <IndividualID>3f21a967-aeba-4f32-b0be-c68c8cc489f0</IndividualID>
  <Name>sample string 3</Name>
  <Completed>true</Completed>
  <Comment>sample string 5</Comment>
  <Why>sample string 6</Why>
  <DueDate>2024-10-24T08:22:40.7996994+00:00</DueDate>
  <PeriodID>7</PeriodID>
  <Measure1>sample string 8</Measure1>
  <Measure1Completed>true</Measure1Completed>
  <Measure1EndDate>2024-10-24T08:22:40.7996994+00:00</Measure1EndDate>
  <Measure1StartDate>2024-10-24T08:22:40.7996994+00:00</Measure1StartDate>
  <Measure2>sample string 9</Measure2>
  <Measure2Completed>true</Measure2Completed>
  <Measure2EndDate>2024-10-24T08:22:40.7996994+00:00</Measure2EndDate>
  <Measure2StartDate>2024-10-24T08:22:40.7996994+00:00</Measure2StartDate>
  <Measure3>sample string 10</Measure3>
  <Measure3Completed>true</Measure3Completed>
  <Measure3EndDate>2024-10-24T08:22:40.7996994+00:00</Measure3EndDate>
  <Measure3StartDate>2024-10-24T08:22:40.7996994+00:00</Measure3StartDate>
  <Measure4>sample string 11</Measure4>
  <Measure4Completed>true</Measure4Completed>
  <Measure4EndDate>2024-10-24T08:22:40.7996994+00:00</Measure4EndDate>
  <Measure4StartDate>2024-10-24T08:22:40.7996994+00:00</Measure4StartDate>
  <Measure5>sample string 12</Measure5>
  <Measure5Completed>true</Measure5Completed>
  <Measure5EndDate>2024-10-24T08:22:40.7996994+00:00</Measure5EndDate>
  <Measure5StartDate>2024-10-24T08:22:40.7996994+00:00</Measure5StartDate>
</Goal>

application/json, text/json

Sample

{
  "SiteID": "05620237-30d2-446b-b771-783dada52720",
  "FullName": "sample string 14",
  "MeasuresCompleted": 1,
  "MeasuresTotal": 1,
  "ID": 1,
  "IndividualID": "3f21a967-aeba-4f32-b0be-c68c8cc489f0",
  "Name": "sample string 3",
  "Completed": true,
  "Comment": "sample string 5",
  "Why": "sample string 6",
  "DueDate": "2024-10-24T08:22:40.7996994+00:00",
  "PeriodID": 7,
  "Measure1": "sample string 8",
  "Measure1Completed": true,
  "Measure1EndDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure1StartDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure2": "sample string 9",
  "Measure2Completed": true,
  "Measure2EndDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure2StartDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure3": "sample string 10",
  "Measure3Completed": true,
  "Measure3EndDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure3StartDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure4": "sample string 11",
  "Measure4Completed": true,
  "Measure4EndDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure4StartDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure5": "sample string 12",
  "Measure5Completed": true,
  "Measure5EndDate": "2024-10-24T08:22:40.7996994+00:00",
  "Measure5StartDate": "2024-10-24T08:22:40.7996994+00:00"
}

Name	Description
ID `integer` Required on Update ID of the given goal.	`integer` Required on Update ID of the given goal.
IndividualID `globally unique identifier` Required on Create ID of the individual for the given goal.	`globally unique identifier` Required on Create ID of the individual for the given goal.
Name `string` Required Name of the given goal.	`string` Required Name of the given goal.
Completed `boolean` Required Completed status of the given goal.	`boolean` Required Completed status of the given goal.
Comment `string` Required Comment about the given goal.	`string` Required Comment about the given goal.
Why `string` Required Reason for the given goal.	`string` Required Reason for the given goal.
DueDate `date` Required Date the given goal should be completed.	`date` Required Date the given goal should be completed.
PeriodID `integer` Required ID of the period for the given goal.	`integer` Required ID of the period for the given goal.
Measure1 `string` Required First objective for the given goal.	`string` Required First objective for the given goal.
Measure1Completed `boolean` Required Completed status of the first objective for the given goal.	`boolean` Required Completed status of the first objective for the given goal.
Measure1EndDate `date` Required End date of the first objective for the given goal.	`date` Required End date of the first objective for the given goal.
Measure1StartDate `date` Required Start date of the first objective for the given goal.	`date` Required Start date of the first objective for the given goal.
Measure2 `string` Required Second objective for the given goal.	`string` Required Second objective for the given goal.
Measure2Completed `boolean` Completed status of the second objective for the given goal.	`boolean` Completed status of the second objective for the given goal.
Measure2EndDate `date` Required End date of the second objective for the given goal.	`date` Required End date of the second objective for the given goal.
Measure2StartDate `date` Required Start date of the second objective for the given goal.	`date` Required Start date of the second objective for the given goal.
Measure3 `string` Required Third objective for the given goal.	`string` Required Third objective for the given goal.
Measure3Completed `boolean` Required Completed status of the third objective for the given goal.	`boolean` Required Completed status of the third objective for the given goal.
Measure3EndDate `date` End date of the third objective for the given goal.	`date` End date of the third objective for the given goal.
Measure3StartDate `date` Required Start date of the third objective for the given goal.	`date` Required Start date of the third objective for the given goal.
Measure4 `string` Required Fourth objective for the given goal.	`string` Required Fourth objective for the given goal.
Measure4Completed `boolean` Required Completed status of the fourth objective for the given goal.	`boolean` Required Completed status of the fourth objective for the given goal.
Measure4EndDate `date` Required End date of the fourth objective for the given goal.	`date` Required End date of the fourth objective for the given goal.
Measure4StartDate `date` Required Start date of the fourth objective for the given goal.	`date` Required Start date of the fourth objective for the given goal.
Measure5 `string` Required Fifth objective for the given goal.	`string` Required Fifth objective for the given goal.
Measure5Completed `boolean` Required Completed status of the fifth objective for the given goal.	`boolean` Required Completed status of the fifth objective for the given goal.
Measure5EndDate `date` Required End date of the fifth objective for the given goal.	`date` Required End date of the fifth objective for the given goal.
Measure5StartDate `date` Required Start date of the fifth objective for the given goal.	`date` Required Start date of the fifth objective for the given goal.
SiteID `globally unique identifier` ReadOnly ID of the site for the given goal.	`globally unique identifier` ReadOnly ID of the site for the given goal.
FullName `string` ReadOnly Full name of the individual for the given goal.	`string` ReadOnly Full name of the individual for the given goal.
MeasuresCompleted `integer` ReadOnly Sum of the measures completed for the given goal.	`integer` ReadOnly Sum of the measures completed for the given goal.
MeasuresTotal `integer` ReadOnly Sum of all the measures for the given goal.	`integer` ReadOnly Sum of all the measures for the given goal.