POST PlanCare2Api/WorkplansV2/{workplanId}/Action
Create a new ActionV2.
Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| workplanId | string |
None |
Body Parameters
The action to save in the workplan.
ActionV2| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The internal id of the Action. |
integer |
None |
| Name |
Name of the Action. |
string |
Required |
| DisciplineId |
The id of the Discipline. |
integer |
Required |
| DisciplineName |
The name of the Discipline. |
string |
None |
| Priority |
The priority of the Action. |
Priority |
None |
| EmployeeId |
The id of the employee who is the executor of the Action. |
Identity |
Deprecated: Please use 'ExecutiveIds' instead. |
| ExecutiveId |
The id of the relation who is the executor of the Action. |
Identity |
Deprecated: Please use 'ExecutiveIds' instead. |
| ExecutiveIds |
List of ids of relations who are executor of the Action. |
Collection of Identity |
None |
| Executives |
List of relations who are executors of the Action. |
Collection of WorkplanActionExecutive |
None |
| WorkTypeId |
The worktype id of the Action. |
integer |
None |
| WorkplanId |
The workplan id of the Action. |
integer |
None |
| SubGoalId |
The sub goal id of the Action. |
integer |
None |
| Remarks |
The exemplification of the Action. |
string |
None |
| EvaluateBefore |
The planned evaluation date. |
date |
None |
| Result |
The result of the Action. |
WorkplanActionResult |
None |
| ResultDate |
The date of the result. |
date |
None |
| Continuation |
The continuation of the Action |
WorkplanActionContinuation |
None |
| CreationDate |
The date of creation. |
date |
None |
| Completed |
Whether or not the Action is completed. |
boolean |
None |
Request Formats
application/json, text/json
{
"Id": 1,
"Name": "sample string 2",
"DisciplineId": 3,
"DisciplineName": "sample string 4",
"Priority": {
"$id": "2",
"Id": 1,
"Name": "sample string 2",
"Color": 3,
"ColorName": "sample string 4"
},
"EmployeeId": {
"$id": "3",
"Identifier": "sample string 1",
"Type": 0
},
"ExecutiveId": {
"$ref": "3"
},
"ExecutiveIds": [
{
"$ref": "3"
},
{
"$ref": "3"
}
],
"Executives": [
{
"$id": "4",
"Identifier": {
"$ref": "3"
},
"ExecutiveType": "sample string 1",
"ExecutiveName": "sample string 2"
},
{
"$ref": "4"
}
],
"WorkTypeId": 1,
"WorkplanId": 1,
"SubGoalId": 1,
"Remarks": "sample string 5",
"EvaluateBefore": "2026-05-26T22:07:36.7005649+02:00",
"Result": {
"$id": "5",
"Id": 1,
"Name": "sample string 2"
},
"ResultDate": "2026-05-26T22:07:36.7005649+02:00",
"Continuation": {
"$id": "6",
"Id": 1,
"Name": "sample string 2"
},
"CreationDate": "2026-05-26T22:07:36.7005649+02:00",
"Completed": true
}
application/xml, text/xml
<ActionV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
<Completed>true</Completed>
<Continuation>
<Id>1</Id>
<Name>sample string 2</Name>
</Continuation>
<CreationDate>2026-05-26T22:07:36.7005649+02:00</CreationDate>
<DisciplineId>3</DisciplineId>
<DisciplineName>sample string 4</DisciplineName>
<EmployeeId xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d2p1:Identifier>sample string 1</d2p1:Identifier>
<d2p1:Type>ExternalId</d2p1:Type>
</EmployeeId>
<EvaluateBefore>2026-05-26T22:07:36.7005649+02:00</EvaluateBefore>
<ExecutiveId xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d2p1:Identifier>sample string 1</d2p1:Identifier>
<d2p1:Type>ExternalId</d2p1:Type>
</ExecutiveId>
<ExecutiveIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d2p1:Identity>
<d2p1:Identifier>sample string 1</d2p1:Identifier>
<d2p1:Type>ExternalId</d2p1:Type>
</d2p1:Identity>
<d2p1:Identity>
<d2p1:Identifier>sample string 1</d2p1:Identifier>
<d2p1:Type>ExternalId</d2p1:Type>
</d2p1:Identity>
</ExecutiveIds>
<Executives>
<WorkplanActionExecutive>
<ExecutiveName>sample string 2</ExecutiveName>
<ExecutiveType>sample string 1</ExecutiveType>
<Identifier 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>
</Identifier>
</WorkplanActionExecutive>
<WorkplanActionExecutive>
<ExecutiveName>sample string 2</ExecutiveName>
<ExecutiveType>sample string 1</ExecutiveType>
<Identifier 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>
</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:36.7005649+02:00</ResultDate>
<SubGoalId>1</SubGoalId>
<WorkTypeId>1</WorkTypeId>
<WorkplanId>1</WorkplanId>
</ActionV2>
Response Information
Resource Description
Returns the HttpResponseMessage which contains the saved action instance.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None |
|
| Content | HttpContent |
None |
|
| StatusCode | HttpStatusCode |
None |
|
| ReasonPhrase | string |
None |
|
| Headers | Collection of Object |
None |
|
| RequestMessage | HttpRequestMessage |
None |
|
| IsSuccessStatusCode | boolean |
None |