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": "c1ae4df6-e5f3-42bc-bdee-2b236db331ee",
"ParentTaskId": "204d4fc6-971e-4fb3-8d1d-7b47b481d38a",
"Integration": {
"IntegrationId": "d05ef218-7de4-4218-ab0f-8bca5237b652",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"444c14cb-8b0d-4ac6-8cb3-b99c2019866b": 2.0,
"55e157b0-ca6c-4b35-908a-4be7ac9fe043": 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": "9c50ff8d-4e98-4716-8820-3c94ecaf7927",
"Name": "sample string 1",
"Created": "2026-09-06T17:05:12.9798148+00:00",
"Modified": "2026-09-06T17:05:12.9798148+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3f8d2247-aa6d-47f6-9a89-7359f6f9b56c",
"5ee01645-32b9-4a5f-a443-05d77156c5e5"
],
"NonLaborAssignments": [
{
"Id": "b1595254-fbae-45bf-b394-be74678f06dd",
"ResourceId": "4b89189d-de7e-465f-853c-0d3df27fab80",
"Quantity": 3.0
},
{
"Id": "b1595254-fbae-45bf-b394-be74678f06dd",
"ResourceId": "4b89189d-de7e-465f-853c-0d3df27fab80",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "712f159d-1f84-453f-b888-c7dd57813603",
"Type": 0,
"ResourceId": "ed0c0f88-9576-4d7d-b46c-285d0d1ca36a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "d0a62c26-126d-47d9-9099-588a91896c9e",
"Start": "2026-09-06T17:05:12.9954473+00:00",
"Due": "2026-09-06T17:05:12.9954473+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "d0a62c26-126d-47d9-9099-588a91896c9e",
"Start": "2026-09-06T17:05:12.9954473+00:00",
"Due": "2026-09-06T17:05:12.9954473+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "712f159d-1f84-453f-b888-c7dd57813603",
"Type": 0,
"ResourceId": "ed0c0f88-9576-4d7d-b46c-285d0d1ca36a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "d0a62c26-126d-47d9-9099-588a91896c9e",
"Start": "2026-09-06T17:05:12.9954473+00:00",
"Due": "2026-09-06T17:05:12.9954473+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "d0a62c26-126d-47d9-9099-588a91896c9e",
"Start": "2026-09-06T17:05:12.9954473+00:00",
"Due": "2026-09-06T17:05:12.9954473+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "69c59eff-ff07-4afc-b29f-45b651dac861",
"WorkTypeParentId": "ab282d14-2911-400d-8c1d-20b4f1d1c0ff",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "645d47db-6340-4f16-9fbf-4cac828a64de",
"UPN": "b355c686-2dc2-43a6-b391-6f530201c90d",
"PostDate": "2026-09-06T17:05:12.9954473+00:00",
"Comment": "sample string 4",
"CC": [
"18004f1b-0cdf-44bf-91e8-9f43279d4888",
"4935b4a4-f3dd-4e17-b6ce-e6a576896e55"
],
"Users": [
"dc6d10ce-be34-41d2-86c5-8d2c3ecc7f73",
"334e42d9-800e-4b83-b246-3784ceb37689"
]
},
{
"Id": "645d47db-6340-4f16-9fbf-4cac828a64de",
"UPN": "b355c686-2dc2-43a6-b391-6f530201c90d",
"PostDate": "2026-09-06T17:05:12.9954473+00:00",
"Comment": "sample string 4",
"CC": [
"18004f1b-0cdf-44bf-91e8-9f43279d4888",
"4935b4a4-f3dd-4e17-b6ce-e6a576896e55"
],
"Users": [
"dc6d10ce-be34-41d2-86c5-8d2c3ecc7f73",
"334e42d9-800e-4b83-b246-3784ceb37689"
]
}
],
"StartDate": "2026-09-06T17:05:12.9954473+00:00",
"DueDate": "2026-09-06T17:05:12.9954473+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b3fbdecc-4a61-4b5d-a5dc-c7761ffc84b1": "ee23fa31-6493-4139-bd55-f2bdd89882bd",
"cd409582-138f-4495-b10a-2d0f4003260e": "b7044e79-dfe1-486f-abc3-a38ad4d0a5f7"
},
"HasUpdates": true,
"Modified": "2026-09-06T17:05:12.9954473+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-09-06T17:05:12.9954473+00:00"
},
"LastComment": "2026-09-06T17:05:12.9954473+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2d855322-6829-47c8-94e2-fe925cbcb191",
"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": "4d316969-a798-4b3f-853e-120cd9d24a88",
"id": "8eb5d798-c5b1-4b8f-b1f4-3e1fd8bd96ed",
"ConfigId": "f73308aa-3694-48f6-9f25-4fab4165ab51"
}