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": "4c9755d1-070f-4210-b0f6-41dd8c465ce6",
"ParentTaskId": "808aaa8f-1355-4f20-9beb-e7284dc7dec5",
"Integration": {
"IntegrationId": "89187847-03c2-42ee-941a-6c072390692f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"18c46d3b-d2a9-479c-941e-340e2f3163e8": 2.0,
"754fae8d-6d8a-4876-9e6c-a5b812c887c2": 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": "4e21712d-b2e3-4ea0-95f7-c3f43e6c50b4",
"Name": "sample string 1",
"Created": "2026-11-04T06:30:17.6507119+00:00",
"Modified": "2026-11-04T06:30:17.6507119+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b7ccc314-519b-42a6-8dcd-f6c6b19de306",
"9e716dc7-7604-43ce-8ef4-73a0829299f8"
],
"NonLaborAssignments": [
{
"Id": "d30acc2a-ad43-4032-b667-104093e7262d",
"ResourceId": "dafce805-f11d-4e7d-a4cf-c39211d619fa",
"Quantity": 3.0
},
{
"Id": "d30acc2a-ad43-4032-b667-104093e7262d",
"ResourceId": "dafce805-f11d-4e7d-a4cf-c39211d619fa",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5725c2b1-65c8-4898-8c08-4106df627488",
"Type": 0,
"ResourceId": "1f489f9f-de54-4b33-b62a-9379d9698867",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b6b527fc-b327-4590-b44c-0905f08f1317",
"Start": "2026-11-04T06:30:17.6507119+00:00",
"Due": "2026-11-04T06:30:17.6507119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b6b527fc-b327-4590-b44c-0905f08f1317",
"Start": "2026-11-04T06:30:17.6507119+00:00",
"Due": "2026-11-04T06:30:17.6507119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "5725c2b1-65c8-4898-8c08-4106df627488",
"Type": 0,
"ResourceId": "1f489f9f-de54-4b33-b62a-9379d9698867",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b6b527fc-b327-4590-b44c-0905f08f1317",
"Start": "2026-11-04T06:30:17.6507119+00:00",
"Due": "2026-11-04T06:30:17.6507119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b6b527fc-b327-4590-b44c-0905f08f1317",
"Start": "2026-11-04T06:30:17.6507119+00:00",
"Due": "2026-11-04T06:30:17.6507119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "bcf7891e-1cdf-4225-85cd-7b85b33e77f7",
"WorkTypeParentId": "fdac62b9-d0a5-47fd-8d55-504b1a1c166e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "65a15542-7b00-4a90-9b4f-eb089a29873e",
"UPN": "58a453af-c268-4d52-8d3a-4ecd84afddc6",
"PostDate": "2026-11-04T06:30:17.6507119+00:00",
"Comment": "sample string 4",
"CC": [
"88ca52e1-5492-49e7-a13b-1d52dc8af259",
"f4acd5b8-5d66-4ee2-a460-6e6be280f7de"
],
"Users": [
"7d54d319-a8c5-45a0-b011-3c688ca8af1d",
"9c6aab48-fe73-40ee-949d-b13d68d7fce6"
]
},
{
"Id": "65a15542-7b00-4a90-9b4f-eb089a29873e",
"UPN": "58a453af-c268-4d52-8d3a-4ecd84afddc6",
"PostDate": "2026-11-04T06:30:17.6507119+00:00",
"Comment": "sample string 4",
"CC": [
"88ca52e1-5492-49e7-a13b-1d52dc8af259",
"f4acd5b8-5d66-4ee2-a460-6e6be280f7de"
],
"Users": [
"7d54d319-a8c5-45a0-b011-3c688ca8af1d",
"9c6aab48-fe73-40ee-949d-b13d68d7fce6"
]
}
],
"StartDate": "2026-11-04T06:30:17.6507119+00:00",
"DueDate": "2026-11-04T06:30:17.6507119+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3c7c2963-f572-4341-8155-6a3fbac351a7": "51469611-1b82-4fe1-a92f-da4f5c6970ad",
"c047b79c-0399-498f-a27e-bc47bb7bd7b7": "38372ba6-2f51-4adc-8d73-fd0e81c4e9d5"
},
"HasUpdates": true,
"Modified": "2026-11-04T06:30:17.6507119+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-11-04T06:30:17.6507119+00:00"
},
"LastComment": "2026-11-04T06:30:17.6507119+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a2090275-a51f-4076-9de8-8b6394309335",
"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": "a5f942b9-344a-42f5-b099-fb23342b5067",
"id": "9a15540c-55c0-47ea-943b-b81ce97d2bf8",
"ConfigId": "3a431a2f-940f-4fc3-85e2-782ee0eb83bc"
}