POST PlanCare2Api/WorkplansV2/{workplanId}/SubGoal

Create a new workplanSubGoalV2.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

Request Information

URI Parameters

Name	Description	Type	Additional information
workplanId		string	-

Body Parameters

The subgoal to save in the workplan.

WorkplanSubGoalV2

Name	Description	Type	Additional information
Id	The internal id of the SubGoal.	integer	-
Name	The name of the SubGoal.	string	Required
Status	The status description of the SubGoal.	WorkplanSubGoalStatus	-
Discipline	The discipline of the SubGoal.	Discipline	-
DisciplineGroup	The discipline group of the SubGoal.	DisciplineGroup	-
Actions	The actions of the SubGoal.	Collection of ActionV2	-
WorkTypeId	The worktype id of the SubGoal.	integer	Nullable
WorkplanId	The id of the Workplan.	integer	Required
Remarks	Additional information about the SubGoal.	string	-

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Status": 0,
  "Discipline": {
    "$id": "2",
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "SpecialismCode": "sample string 4",
    "IsActual": true,
    "DisciplineGroupId": 6,
    "EvsFunction": "sample string 7",
    "EvsSpecialism": "sample string 8",
    "ReferralAllowed": true
  },
  "DisciplineGroup": {
    "$id": "3",
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Disciplines": [
      {
        "$ref": "2"
      },
      {
        "$ref": "2"
      }
    ]
  },
  "Actions": [
    {
      "$id": "4",
      "Id": 1,
      "Name": "sample string 2",
      "DisciplineId": 3,
      "DisciplineName": "sample string 4",
      "Priority": {
        "$id": "5",
        "Id": 1,
        "Name": "sample string 2",
        "Color": 3,
        "ColorName": "sample string 4"
      },
      "EmployeeId": {
        "$id": "6",
        "Identifier": "sample string 1",
        "Type": 0
      },
      "ExecutiveId": {
        "$ref": "6"
      },
      "ExecutiveIds": [
        1,
        2
      ],
      "Executives": [
        {
          "$id": "7",
          "Identifier": {
            "$ref": "6"
          },
          "ExecutiveType": "sample string 1",
          "ExecutiveName": "sample string 2"
        },
        {
          "$ref": "7"
        }
      ],
      "WorkTypeId": 1,
      "WorkplanId": 1,
      "SubGoalId": 1,
      "Remarks": "sample string 5",
      "EvaluateBefore": "2026-05-26T22:07:14.9349537+02:00",
      "Result": {
        "$id": "8",
        "Id": 1,
        "Name": "sample string 2"
      },
      "ResultDate": "2026-05-26T22:07:14.9349537+02:00",
      "Continuation": {
        "$id": "9",
        "Id": 1,
        "Name": "sample string 2"
      },
      "CreationDate": "2026-05-26T22:07:14.9349537+02:00",
      "Completed": true
    },
    {
      "$ref": "4"
    }
  ],
  "WorkTypeId": 1,
  "WorkplanId": 3,
  "Remarks": "sample string 4"
}

application/xml, text/xml

Sample:

<WorkplanSubGoalV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <Actions>
    <ActionV2>
      <Completed>true</Completed>
      <Continuation>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Continuation>
      <CreationDate>2026-05-26T22:07:14.9349537+02:00</CreationDate>
      <DisciplineId>3</DisciplineId>
      <DisciplineName>sample string 4</DisciplineName>
      <EmployeeId xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </EmployeeId>
      <EvaluateBefore>2026-05-26T22:07:14.9349537+02:00</EvaluateBefore>
      <ExecutiveId xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </ExecutiveId>
      <ExecutiveIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </ExecutiveIds>
      <Executives>
        <WorkplanActionExecutive>
          <ExecutiveName>sample string 2</ExecutiveName>
          <ExecutiveType>sample string 1</ExecutiveType>
          <Identifier xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
            <d6p1:Identifier>sample string 1</d6p1:Identifier>
            <d6p1:Type>ExternalId</d6p1:Type>
          </Identifier>
        </WorkplanActionExecutive>
        <WorkplanActionExecutive>
          <ExecutiveName>sample string 2</ExecutiveName>
          <ExecutiveType>sample string 1</ExecutiveType>
          <Identifier xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
            <d6p1:Identifier>sample string 1</d6p1:Identifier>
            <d6p1:Type>ExternalId</d6p1:Type>
          </Identifier>
        </WorkplanActionExecutive>
      </Executives>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Priority>
        <Color>3</Color>
        <ColorName>sample string 4</ColorName>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Priority>
      <Remarks>sample string 5</Remarks>
      <Result>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Result>
      <ResultDate>2026-05-26T22:07:14.9349537+02:00</ResultDate>
      <SubGoalId>1</SubGoalId>
      <WorkTypeId>1</WorkTypeId>
      <WorkplanId>1</WorkplanId>
    </ActionV2>
    <ActionV2>
      <Completed>true</Completed>
      <Continuation>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Continuation>
      <CreationDate>2026-05-26T22:07:14.9349537+02:00</CreationDate>
      <DisciplineId>3</DisciplineId>
      <DisciplineName>sample string 4</DisciplineName>
      <EmployeeId xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </EmployeeId>
      <EvaluateBefore>2026-05-26T22:07:14.9349537+02:00</EvaluateBefore>
      <ExecutiveId xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </ExecutiveId>
      <ExecutiveIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </ExecutiveIds>
      <Executives>
        <WorkplanActionExecutive>
          <ExecutiveName>sample string 2</ExecutiveName>
          <ExecutiveType>sample string 1</ExecutiveType>
          <Identifier xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
            <d6p1:Identifier>sample string 1</d6p1:Identifier>
            <d6p1:Type>ExternalId</d6p1:Type>
          </Identifier>
        </WorkplanActionExecutive>
        <WorkplanActionExecutive>
          <ExecutiveName>sample string 2</ExecutiveName>
          <ExecutiveType>sample string 1</ExecutiveType>
          <Identifier xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
            <d6p1:Identifier>sample string 1</d6p1:Identifier>
            <d6p1:Type>ExternalId</d6p1:Type>
          </Identifier>
        </WorkplanActionExecutive>
      </Executives>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Priority>
        <Color>3</Color>
        <ColorName>sample string 4</ColorName>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Priority>
      <Remarks>sample string 5</Remarks>
      <Result>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Result>
      <ResultDate>2026-05-26T22:07:14.9349537+02:00</ResultDate>
      <SubGoalId>1</SubGoalId>
      <WorkTypeId>1</WorkTypeId>
      <WorkplanId>1</WorkplanId>
    </ActionV2>
  </Actions>
  <Discipline xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DisciplineGroupId>6</d2p1:DisciplineGroupId>
    <d2p1:EvsFunction>sample string 7</d2p1:EvsFunction>
    <d2p1:EvsSpecialism>sample string 8</d2p1:EvsSpecialism>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsActual>true</d2p1:IsActual>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:ReferralAllowed>true</d2p1:ReferralAllowed>
    <d2p1:SpecialismCode>sample string 4</d2p1:SpecialismCode>
  </Discipline>
  <DisciplineGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:Disciplines>
      <d2p1:Discipline>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:DisciplineGroupId>6</d2p1:DisciplineGroupId>
        <d2p1:EvsFunction>sample string 7</d2p1:EvsFunction>
        <d2p1:EvsSpecialism>sample string 8</d2p1:EvsSpecialism>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:IsActual>true</d2p1:IsActual>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:ReferralAllowed>true</d2p1:ReferralAllowed>
        <d2p1:SpecialismCode>sample string 4</d2p1:SpecialismCode>
      </d2p1:Discipline>
      <d2p1:Discipline>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:DisciplineGroupId>6</d2p1:DisciplineGroupId>
        <d2p1:EvsFunction>sample string 7</d2p1:EvsFunction>
        <d2p1:EvsSpecialism>sample string 8</d2p1:EvsSpecialism>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:IsActual>true</d2p1:IsActual>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:ReferralAllowed>true</d2p1:ReferralAllowed>
        <d2p1:SpecialismCode>sample string 4</d2p1:SpecialismCode>
      </d2p1:Discipline>
    </d2p1:Disciplines>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </DisciplineGroup>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <Remarks>sample string 4</Remarks>
  <Status>Concept</Status>
  <WorkTypeId>1</WorkTypeId>
  <WorkplanId>3</WorkplanId>
</WorkplanSubGoalV2>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved subgoal instance.

HttpResponseMessage

Name	Type	Additional information
Version	Version	-
Content	HttpContent	-
StatusCode	HttpStatusCode	-
ReasonPhrase	string	-
Headers	Collection of Object	-
RequestMessage	HttpRequestMessage	-
IsSuccessStatusCode	boolean	-