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": "86db1ddd-1f07-4bc4-b141-1b44086c7123",
"ParentTaskId": "18e20c6a-da7c-4b6d-94f0-14c2c3470359",
"Integration": {
"IntegrationId": "80b490be-8306-4003-9131-3a35d47433ca",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"91f7b9dc-2c73-4351-80b1-a0232d8542e4": 2.0,
"5ce963d0-44eb-4f15-a849-fb3b94e0b555": 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": "aba4da5b-7d4d-44c5-b9a4-9ff8a0d4bdca",
"Name": "sample string 1",
"Created": "2026-10-31T10:29:26.5117773+00:00",
"Modified": "2026-10-31T10:29:26.5117773+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4ede138d-ead7-44a6-84f6-9e132b968fda",
"1978fd5b-fa6f-45ed-a1ea-e888ee916fb5"
],
"NonLaborAssignments": [
{
"Id": "648be384-1c88-4a3f-aeda-b8fe9eaa26c9",
"ResourceId": "aff32e49-a162-4603-acbc-b7b983df3c18",
"Quantity": 3.0
},
{
"Id": "648be384-1c88-4a3f-aeda-b8fe9eaa26c9",
"ResourceId": "aff32e49-a162-4603-acbc-b7b983df3c18",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e272a15c-3cfd-4d71-b25c-cb9892612b25",
"Type": 0,
"ResourceId": "348ab237-c012-4eac-9b78-2a515821650c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3189e6ce-d864-44ea-b7ec-ffb2b1b95c72",
"Start": "2026-10-31T10:29:26.5117773+00:00",
"Due": "2026-10-31T10:29:26.5117773+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3189e6ce-d864-44ea-b7ec-ffb2b1b95c72",
"Start": "2026-10-31T10:29:26.5117773+00:00",
"Due": "2026-10-31T10:29:26.5117773+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "e272a15c-3cfd-4d71-b25c-cb9892612b25",
"Type": 0,
"ResourceId": "348ab237-c012-4eac-9b78-2a515821650c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3189e6ce-d864-44ea-b7ec-ffb2b1b95c72",
"Start": "2026-10-31T10:29:26.5117773+00:00",
"Due": "2026-10-31T10:29:26.5117773+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3189e6ce-d864-44ea-b7ec-ffb2b1b95c72",
"Start": "2026-10-31T10:29:26.5117773+00:00",
"Due": "2026-10-31T10:29:26.5117773+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "42b12884-8868-4809-85b3-9b2b2e98932a",
"WorkTypeParentId": "1bffbf10-24ae-4e89-91c5-ebabf0390bb9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1474df2e-4e38-4187-916d-dd34a2f392ea",
"UPN": "22048602-25ef-442e-aeeb-40b189122497",
"PostDate": "2026-10-31T10:29:26.5117773+00:00",
"Comment": "sample string 4",
"CC": [
"f23742af-edb3-4199-a3cd-904f5701c023",
"e2320d26-5272-4607-a392-546f0961acca"
],
"Users": [
"0099d42e-6ac9-43f2-9ef6-09fdb859ae45",
"11428c0f-75e6-447b-84e7-8a2c87305bb5"
]
},
{
"Id": "1474df2e-4e38-4187-916d-dd34a2f392ea",
"UPN": "22048602-25ef-442e-aeeb-40b189122497",
"PostDate": "2026-10-31T10:29:26.5117773+00:00",
"Comment": "sample string 4",
"CC": [
"f23742af-edb3-4199-a3cd-904f5701c023",
"e2320d26-5272-4607-a392-546f0961acca"
],
"Users": [
"0099d42e-6ac9-43f2-9ef6-09fdb859ae45",
"11428c0f-75e6-447b-84e7-8a2c87305bb5"
]
}
],
"StartDate": "2026-10-31T10:29:26.5117773+00:00",
"DueDate": "2026-10-31T10:29:26.5117773+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"51e884d0-5c1e-405f-bd12-63b1f6f40d3d": "708591ae-5f19-429d-b026-2387b5dfdad4",
"9b67f8cd-0d21-41a8-b699-73b533a51599": "dab44378-cc2b-42c9-902a-6a801c46637b"
},
"HasUpdates": true,
"Modified": "2026-10-31T10:29:26.5117773+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-10-31T10:29:26.5117773+00:00"
},
"LastComment": "2026-10-31T10:29:26.5117773+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "693a5758-c77f-45b2-850d-393c554aa22f",
"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": "aa66da06-19e0-4fba-83ca-e50adbbea36e",
"id": "ce102ca6-b253-4dc9-ba1a-6220a6217298",
"ConfigId": "74c73700-0e90-4da1-ae84-b0d3be1a341c"
}