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": "e2762232-9266-4e23-b0f4-058884ab43c3",
"ParentTaskId": "3f69cf04-ed15-4abc-99d6-ce634edae50b",
"Integration": {
"IntegrationId": "8860e973-57e2-4667-af55-baf8126e492a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"904026ae-7be5-41da-9313-8ea52f940ea4": 2.0,
"4a5e19d1-7055-49c5-9cd1-63ae493b0c10": 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": "cb9cd714-2a1d-4952-a7ef-0cba01322dbf",
"Name": "sample string 1",
"Created": "2026-10-30T06:51:38.1174603+00:00",
"Modified": "2026-10-30T06:51:38.1174603+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"33d83505-a3e2-4a80-a5ea-f6e2592afe5c",
"b6395b13-943f-49cf-a46f-ee3fac0b472f"
],
"NonLaborAssignments": [
{
"Id": "fe471eca-68f8-4f2b-b75e-b6f65bbf3ba9",
"ResourceId": "63a47384-b99e-4348-8b4a-21a68892973a",
"Quantity": 3.0
},
{
"Id": "fe471eca-68f8-4f2b-b75e-b6f65bbf3ba9",
"ResourceId": "63a47384-b99e-4348-8b4a-21a68892973a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "35fd66cf-23e2-4061-ba44-dd142c21330c",
"Type": 0,
"ResourceId": "5a9f859a-db51-4701-8d6f-3d07b293af25",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3d01cd8d-7ccd-4edb-ac56-0e1bbe019556",
"Start": "2026-10-30T06:51:38.1174603+00:00",
"Due": "2026-10-30T06:51:38.1174603+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3d01cd8d-7ccd-4edb-ac56-0e1bbe019556",
"Start": "2026-10-30T06:51:38.1174603+00:00",
"Due": "2026-10-30T06:51:38.1174603+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "35fd66cf-23e2-4061-ba44-dd142c21330c",
"Type": 0,
"ResourceId": "5a9f859a-db51-4701-8d6f-3d07b293af25",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3d01cd8d-7ccd-4edb-ac56-0e1bbe019556",
"Start": "2026-10-30T06:51:38.1174603+00:00",
"Due": "2026-10-30T06:51:38.1174603+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3d01cd8d-7ccd-4edb-ac56-0e1bbe019556",
"Start": "2026-10-30T06:51:38.1174603+00:00",
"Due": "2026-10-30T06:51:38.1174603+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "1169ab96-cb7d-4f65-a6cd-6b7e039a9aa1",
"WorkTypeParentId": "ce958514-6588-4817-a522-ed516a3dda80",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c3c087f0-40d4-476f-aef9-d3b2a55a52ed",
"UPN": "d7a03830-515d-4dc1-b6f4-0e6800337a3a",
"PostDate": "2026-10-30T06:51:38.1174603+00:00",
"Comment": "sample string 4",
"CC": [
"fd3080bc-8fe0-41d7-8516-ac61def9589f",
"7be0f166-faed-4dbf-9bdd-c5c40fbc6f1f"
],
"Users": [
"80eb5d7e-9a45-4181-addf-f58aa11bbea7",
"8dda2e6b-48e4-46d0-92cf-eacab29555be"
]
},
{
"Id": "c3c087f0-40d4-476f-aef9-d3b2a55a52ed",
"UPN": "d7a03830-515d-4dc1-b6f4-0e6800337a3a",
"PostDate": "2026-10-30T06:51:38.1174603+00:00",
"Comment": "sample string 4",
"CC": [
"fd3080bc-8fe0-41d7-8516-ac61def9589f",
"7be0f166-faed-4dbf-9bdd-c5c40fbc6f1f"
],
"Users": [
"80eb5d7e-9a45-4181-addf-f58aa11bbea7",
"8dda2e6b-48e4-46d0-92cf-eacab29555be"
]
}
],
"StartDate": "2026-10-30T06:51:38.1174603+00:00",
"DueDate": "2026-10-30T06:51:38.1174603+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e9cd84b4-71f0-4f60-82e9-7481acd9603f": "71e4dfed-cc59-4b11-9287-c168be464d70",
"6d2e94c1-513a-4d60-a661-0b7347620dee": "2e603d11-f68a-4244-9066-d164a0b115fd"
},
"HasUpdates": true,
"Modified": "2026-10-30T06:51:38.1174603+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-30T06:51:38.1174603+00:00"
},
"LastComment": "2026-10-30T06:51:38.1174603+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0fdb2c7d-aa4c-47ee-a5c5-a9dc15a1a094",
"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": "a05910f9-651e-4bc2-9c45-a7cca41c6ae0",
"id": "a0212fc4-5fc9-4523-9dea-8551048aff5a",
"ConfigId": "f560183b-e2c9-4cea-b58a-803c13094923"
}