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": "d2f621c5-ecb8-4203-ab02-3b45ec15d4bb",
"ParentTaskId": "d81ccdf2-d185-4623-8bd1-56d4631a91e9",
"Integration": {
"IntegrationId": "0f28085d-abc5-47b8-b8cb-02aecf76818d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a0f9d923-4a59-45f8-b3f7-c8b00a0f43f7": 2.0,
"81fd0951-f29c-4d43-b640-e5887e94cb62": 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": "5d67de53-29a8-4ad9-bd56-4e2512d956e0",
"Name": "sample string 1",
"Created": "2026-08-29T00:39:51.3966951+00:00",
"Modified": "2026-08-29T00:39:51.3966951+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1689eee7-10db-4fae-99cc-becc8953e7b0",
"0105a3cc-7611-4de4-ab1f-be63594048e4"
],
"NonLaborAssignments": [
{
"Id": "8756d907-d0c6-417e-b9b7-b38bddc5f2bf",
"ResourceId": "704e4305-aa67-4ec0-bc3b-3119b23c0336",
"Quantity": 3.0
},
{
"Id": "8756d907-d0c6-417e-b9b7-b38bddc5f2bf",
"ResourceId": "704e4305-aa67-4ec0-bc3b-3119b23c0336",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "c6b33266-78f9-4514-b85c-f21151c83030",
"Type": 0,
"ResourceId": "f07a73fb-0f93-482d-a57e-fc2fe5c10920",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "618ec4a6-dc4b-4fc6-98d1-9451de53e10e",
"Start": "2026-08-29T00:39:51.3966951+00:00",
"Due": "2026-08-29T00:39:51.3966951+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "618ec4a6-dc4b-4fc6-98d1-9451de53e10e",
"Start": "2026-08-29T00:39:51.3966951+00:00",
"Due": "2026-08-29T00:39:51.3966951+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "c6b33266-78f9-4514-b85c-f21151c83030",
"Type": 0,
"ResourceId": "f07a73fb-0f93-482d-a57e-fc2fe5c10920",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "618ec4a6-dc4b-4fc6-98d1-9451de53e10e",
"Start": "2026-08-29T00:39:51.3966951+00:00",
"Due": "2026-08-29T00:39:51.3966951+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "618ec4a6-dc4b-4fc6-98d1-9451de53e10e",
"Start": "2026-08-29T00:39:51.3966951+00:00",
"Due": "2026-08-29T00:39:51.3966951+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "a9c3814c-a2b1-4ad5-a785-12f27ac511fd",
"WorkTypeParentId": "3efe41c1-561b-49e1-abb1-e982f774317d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cea0d043-9561-4d02-b296-9d10547a6c81",
"UPN": "e5712293-c9b0-42c6-b63e-894bd999bfb8",
"PostDate": "2026-08-29T00:39:51.3966951+00:00",
"Comment": "sample string 4",
"CC": [
"a8b5f301-cf16-42ac-ae7f-b768552d59c6",
"b158d713-29a3-41eb-a37c-829ec720486b"
],
"Users": [
"894ff065-1f71-417b-97f3-c4fd24afbc31",
"a6f1a7da-1661-4870-b53f-88496f7b0acf"
]
},
{
"Id": "cea0d043-9561-4d02-b296-9d10547a6c81",
"UPN": "e5712293-c9b0-42c6-b63e-894bd999bfb8",
"PostDate": "2026-08-29T00:39:51.3966951+00:00",
"Comment": "sample string 4",
"CC": [
"a8b5f301-cf16-42ac-ae7f-b768552d59c6",
"b158d713-29a3-41eb-a37c-829ec720486b"
],
"Users": [
"894ff065-1f71-417b-97f3-c4fd24afbc31",
"a6f1a7da-1661-4870-b53f-88496f7b0acf"
]
}
],
"StartDate": "2026-08-29T00:39:51.3966951+00:00",
"DueDate": "2026-08-29T00:39:51.3966951+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ff590b91-30b2-4028-8f1e-e68ac4f9326f": "dbb00b99-44c3-4ae6-915e-ea55bf50ecbe",
"b75b45b3-7d68-4331-a985-6ae8f9a4a0d6": "0c0bdb69-2fca-4473-8273-c8dda9a46a00"
},
"HasUpdates": true,
"Modified": "2026-08-29T00:39:51.3966951+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-29T00:39:51.3966951+00:00"
},
"LastComment": "2026-08-29T00:39:51.3966951+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "299834ce-55aa-44a2-9c9c-f73425392f6b",
"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": "781a88eb-d554-417b-b1ca-78340ef0d469",
"id": "211fdc8f-de55-4e21-9589-50208e9ec248",
"ConfigId": "98dbf816-6ec6-438f-87f2-d636177ec0cb"
}