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": "f55a9991-f36d-44ae-8200-8b0468867ce6",
"ParentTaskId": "2efedc60-332e-4aa2-99a7-b53442b86b24",
"Integration": {
"IntegrationId": "0b15ceef-05c9-4fc5-ae6f-139a39da40b1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9c8dd2c6-6fb1-44af-a807-be6618f65055": 2.0,
"663cfd2f-4226-473c-ba44-a9e08bbff34d": 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": "b1224b82-dd17-4a54-9547-0420333ef7d1",
"Name": "sample string 1",
"Created": "2026-04-12T05:03:15.0591074+00:00",
"Modified": "2026-04-12T05:03:15.0591074+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3e54ea2a-6d41-48db-b476-67dc16076e28",
"7e8927bc-54bd-45e1-b528-8a3d09b8efbf"
],
"NonLaborAssignments": [
{
"Id": "b66f5446-17ba-4033-9c59-c4b79d3b9177",
"ResourceId": "ffa41221-a73e-4989-9339-cafe152350bb",
"Quantity": 3.0
},
{
"Id": "b66f5446-17ba-4033-9c59-c4b79d3b9177",
"ResourceId": "ffa41221-a73e-4989-9339-cafe152350bb",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "87de98d9-4095-48f6-86f2-60448d49e859",
"Type": 0,
"ResourceId": "18099f22-c707-4db5-9c9d-8d252e7e80b0",
"Units": 3.0
},
{
"Id": "87de98d9-4095-48f6-86f2-60448d49e859",
"Type": 0,
"ResourceId": "18099f22-c707-4db5-9c9d-8d252e7e80b0",
"Units": 3.0
}
],
"ParentId": "68969dab-16b3-4ee6-8f75-8de6ba7cec47",
"WorkTypeParentId": "e7503042-04ff-4825-a263-05ecef48e66b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "224323b0-7629-4008-a95f-bc9739319861",
"UPN": "e36e5034-d4fe-4710-810c-d879e808b0e8",
"PostDate": "2026-04-12T05:03:15.0591074+00:00",
"Comment": "sample string 4",
"CC": [
"e99a1822-e27b-4c33-bacb-72114c32fc71",
"18a6913b-2600-48de-b86a-61a3f0e175ba"
],
"Users": [
"d9bb91da-18be-4ce9-b303-25f15052b2d7",
"e641bad6-45f9-4453-b393-260c1045b063"
]
},
{
"Id": "224323b0-7629-4008-a95f-bc9739319861",
"UPN": "e36e5034-d4fe-4710-810c-d879e808b0e8",
"PostDate": "2026-04-12T05:03:15.0591074+00:00",
"Comment": "sample string 4",
"CC": [
"e99a1822-e27b-4c33-bacb-72114c32fc71",
"18a6913b-2600-48de-b86a-61a3f0e175ba"
],
"Users": [
"d9bb91da-18be-4ce9-b303-25f15052b2d7",
"e641bad6-45f9-4453-b393-260c1045b063"
]
}
],
"StartDate": "2026-04-12T05:03:15.0591074+00:00",
"DueDate": "2026-04-12T05:03:15.0591074+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"95d0004a-750b-4612-bd93-3d11d19a157c": "3c6dd1b6-b94e-4b8c-9925-59b7ad43ec83",
"3574d58c-a3e0-45d5-af05-40948c664011": "607ca0e6-897c-40b8-98c7-0a4ca5d580c5"
},
"HasUpdates": true,
"Modified": "2026-04-12T05:03:15.0591074+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-04-12T05:03:15.0591074+00:00"
},
"LastComment": "2026-04-12T05:03:15.0591074+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "bb276899-094b-4a6e-9a0e-66c891ffce1e",
"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": "b8d13789-6d78-44f7-86cf-ccbf8848118c",
"id": "1789d5a8-fb2b-4c16-9b82-15514da6b842",
"ConfigId": "c726bd94-120f-436c-b741-525fd4f4dfbe"
}