POST v1/person/{personid}/goals

Creates a new goal for the specified user (scope: manager or administrator)

Request Information

URI Parameters

Name	Description	Type	Additional Information
personID	Person's ID	string	Required.

Body Parameters

Information about a new goal

NewGoalModel

Name	Description	Type	Additional Information
Name	The goal's name, which should be five to seven action-oriented words.	string	Required.
Description	The goal's description, which contains detailed information about what it will take to achieve this goal.	string	None.
StartDate	The date when the goal starts.	date	Required. The start date must not be after the due date.
DueDate	The date when the goal is due.	date	Required. The start date must not be after the due date.
IsPrivate	Flag that indicates whether this goal is public or private. Private goals are visible to the user's manager and above. They are not visible to the user's peer or subordinates.	boolean	Required.
ObjectiveID	The ID of the objective to which the efforts of this goal contribute.	string	Required. The objective must be one to which the user can associate goals.

Request Formats

application/json, text/json, text/html

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "StartDate": "2025-05-24T10:19:08.3433876+00:00",
  "DueDate": "2025-05-24T10:19:08.3433876+00:00",
  "IsPrivate": true,
  "ObjectiveID": "sample string 6"
}

application/xml, text/xml

Sample:

<NewGoalModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <Description>sample string 2</Description>
  <DueDate>2025-05-24T10:19:08.3433876+00:00</DueDate>
  <IsPrivate>true</IsPrivate>
  <Name>sample string 1</Name>
  <ObjectiveID>sample string 6</ObjectiveID>
  <StartDate>2025-05-24T10:19:08.3433876+00:00</StartDate>
</NewGoalModel>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "ID": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "StartDate": "2025-05-24T10:19:08.3433876+00:00",
  "DueDate": "2025-05-24T10:19:08.3433876+00:00",
  "EndDate": "2025-05-24T10:19:08.3433876+00:00",
  "State": "sample string 6",
  "Status": "sample string 7",
  "PercentageComplete": 8,
  "IsPrivate": true,
  "AssignedTo": {
    "ID": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email": "sample string 4"
  },
  "Objective": {
    "ID": "sample string 1",
    "Name": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<GoalModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <AssignedTo>
    <Email>sample string 4</Email>
    <FirstName>sample string 2</FirstName>
    <ID>sample string 1</ID>
    <LastName>sample string 3</LastName>
  </AssignedTo>
  <Description>sample string 3</Description>
  <DueDate>2025-05-24T10:19:08.3433876+00:00</DueDate>
  <EndDate>2025-05-24T10:19:08.3433876+00:00</EndDate>
  <ID>sample string 1</ID>
  <IsPrivate>true</IsPrivate>
  <Name>sample string 2</Name>
  <Objective>
    <ID>sample string 1</ID>
    <Name>sample string 2</Name>
  </Objective>
  <PercentageComplete>8</PercentageComplete>
  <StartDate>2025-05-24T10:19:08.3433876+00:00</StartDate>
  <State>sample string 6</State>
  <Status>sample string 7</Status>
</GoalModel>