POST api/workplan/{id}/tasks
Add Task
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Work Plan Id |
globally unique identifier |
Required |
Body Parameters
TasksRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| WorkTypeId | globally unique identifier |
None. |
|
| ParentTaskId | globally unique identifier |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| Assignments | Dictionary of globally unique identifier [key] and decimal number [value] |
None. |
|
| ProcessAssignments | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"WorkTypeId": "0465a263-8a46-4904-92b1-46c3c4cfa538",
"ParentTaskId": "79a880e0-f697-462e-a5d7-d600c180f19c",
"Integration": {
"IntegrationId": "47a349b5-f967-487c-95a4-6867dcc601ca",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"208f2331-9c36-439c-99da-8d0d8f79bf9f": 2.0,
"a0a41a3f-5d13-438b-8ea8-1ff7dd549b68": 4.0
},
"ProcessAssignments": true
}
Response Information
Resource Description
WorkPlanTask| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| Author | string |
None. |
|
| Editor | string |
None. |
|
| AssignedTo | Collection of globally unique identifier |
None. |
|
| NonLaborAssignments | Collection of TaskNonLaborAssignment |
None. |
|
| Assignments | Collection of TaskAssignment |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| WorkTypeParentId | globally unique identifier |
None. |
|
| WorkTypeIndex | integer |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| Index | integer |
None. |
|
| Complete | boolean |
None. |
|
| Comments | Collection of TaskComment |
None. |
|
| StartDate | date |
None. |
|
| DueDate | date |
None. |
|
| TaskScheduleType | TaskType |
None. |
|
| StatusUpdate | StatusUpdateClass |
None. |
|
| LastComment | date |
None. |
|
| IsScheduled | boolean |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| LinkedFileIds | Collection of string |
None. |
|
| LinkedLinkIds | Collection of string |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "02622b0d-200c-404a-a34a-907274262893",
"Name": "sample string 1",
"Created": "2026-08-17T01:59:00.0605404+00:00",
"Modified": "2026-08-17T01:59:00.0605404+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"af157a45-8e3c-47d4-8c6c-5438fd74baec",
"79276fd0-f934-4684-86f4-351d334b7df2"
],
"NonLaborAssignments": [
{
"Id": "fb60ca4e-5a04-4929-90be-451317550522",
"ResourceId": "772ab8ca-8c93-4187-a61f-cd79f061c204",
"Quantity": 3.0
},
{
"Id": "fb60ca4e-5a04-4929-90be-451317550522",
"ResourceId": "772ab8ca-8c93-4187-a61f-cd79f061c204",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "78b11070-c923-49f6-97f6-bd951488309d",
"Type": 0,
"ResourceId": "b0f3ad58-d0e8-43d4-ae4c-c835b436f838",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "78b11070-c923-49f6-97f6-bd951488309d",
"Type": 0,
"ResourceId": "b0f3ad58-d0e8-43d4-ae4c-c835b436f838",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "27354c0e-bd6d-428a-8079-c62c5f74a669",
"WorkTypeParentId": "9cf4f1a3-fd5d-4b75-926f-ea11a2220954",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "93a254ba-cfc4-4289-a865-1d2183954319",
"UPN": "b92b4a24-f7f9-4b78-a40a-7169d04632da",
"PostDate": "2026-08-17T01:59:00.0605404+00:00",
"Comment": "sample string 4",
"CC": [
"eac4003c-809b-4b48-8e45-54ccaa5e2925",
"31abbbcd-5335-475a-bd79-3d44aef5aa46"
],
"Users": [
"671995e9-03cc-49bd-9770-8fdfa60af781",
"f0dcfa64-a361-415f-8331-47dfd8c79783"
]
},
{
"Id": "93a254ba-cfc4-4289-a865-1d2183954319",
"UPN": "b92b4a24-f7f9-4b78-a40a-7169d04632da",
"PostDate": "2026-08-17T01:59:00.0605404+00:00",
"Comment": "sample string 4",
"CC": [
"eac4003c-809b-4b48-8e45-54ccaa5e2925",
"31abbbcd-5335-475a-bd79-3d44aef5aa46"
],
"Users": [
"671995e9-03cc-49bd-9770-8fdfa60af781",
"f0dcfa64-a361-415f-8331-47dfd8c79783"
]
}
],
"StartDate": "2026-08-17T01:59:00.0605404+00:00",
"DueDate": "2026-08-17T01:59:00.0605404+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bbb612e2-6e5d-4c1c-8094-bdc2622a4615": "6fb49278-7326-4059-bef0-d96edc359a79",
"0d0cb7bd-eb53-410e-a614-9c82a1f6c162": "a4a43178-5f20-4371-b3b1-da739ec37592"
},
"HasUpdates": true,
"Modified": "2026-08-17T01:59:00.0605404+00:00",
"Editor": "sample string 3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"CalcFields": {
"sample string 1": {},
"sample string 3": {}
},
"State": 0,
"ApproveRejectBy": "sample string 4",
"ApproveRejectDate": "2026-08-17T01:59:00.0605404+00:00"
},
"LastComment": "2026-08-17T01:59:00.0605404+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5af23a1c-f196-4c2f-820c-e66de42e95a9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "ae4a6052-604b-430d-9840-3ac9b8a3a3ef",
"id": "dfad0fda-8aba-4db1-99a9-725db7bcfa77",
"ConfigId": "44ade4f6-341c-4b57-bbb3-b010f295cb79"
}