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": "446dcdd3-0689-4a74-8294-2f8350f6724f",
"ParentTaskId": "d0402a83-f7df-4fc5-985d-e1955b07a24f",
"Integration": {
"IntegrationId": "ff85b54f-6710-482b-b29b-de3769f7dfbd",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"dd308d8f-fa26-4589-b77e-c31b13ffff8d": 2.0,
"db43993b-48c7-4c23-a8d9-ff6d9cb31fec": 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": "059034ab-514b-4b04-b5b7-c91136148683",
"Name": "sample string 1",
"Created": "2026-06-27T14:50:47.4979176+00:00",
"Modified": "2026-06-27T14:50:47.4979176+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5c9edfa0-3c35-469f-b808-d883003bc86d",
"c073eba2-2324-4541-a351-285ba9fa04f9"
],
"NonLaborAssignments": [
{
"Id": "adc634a2-a39e-450c-bb86-c5bc6a22fd20",
"ResourceId": "2929f86a-4e8d-4398-96dc-b571ac490575",
"Quantity": 3.0
},
{
"Id": "adc634a2-a39e-450c-bb86-c5bc6a22fd20",
"ResourceId": "2929f86a-4e8d-4398-96dc-b571ac490575",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ab798f6d-d37e-449b-bb06-36a40e6adfb5",
"Type": 0,
"ResourceId": "63d01984-411a-4925-ad8f-f7b3cb469994",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "ab798f6d-d37e-449b-bb06-36a40e6adfb5",
"Type": 0,
"ResourceId": "63d01984-411a-4925-ad8f-f7b3cb469994",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "23a85898-4f84-42fb-9590-c3a1abffa645",
"WorkTypeParentId": "87aa8d4a-5f6b-4bb8-b9d6-dbe99c76f030",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "204d05e9-4246-4df5-8a59-5cbb2404f67f",
"UPN": "45537e0d-40e4-454d-899f-996589263de9",
"PostDate": "2026-06-27T14:50:47.4979176+00:00",
"Comment": "sample string 4",
"CC": [
"e8b2ffa7-06e2-4d82-bf5a-60f86616ad05",
"cddf20a3-20fd-445f-8dd1-85c455382357"
],
"Users": [
"7a879d81-34ad-49d5-80a4-3987fe11780e",
"3715ef46-3aea-4ced-8ac8-027063598be5"
]
},
{
"Id": "204d05e9-4246-4df5-8a59-5cbb2404f67f",
"UPN": "45537e0d-40e4-454d-899f-996589263de9",
"PostDate": "2026-06-27T14:50:47.4979176+00:00",
"Comment": "sample string 4",
"CC": [
"e8b2ffa7-06e2-4d82-bf5a-60f86616ad05",
"cddf20a3-20fd-445f-8dd1-85c455382357"
],
"Users": [
"7a879d81-34ad-49d5-80a4-3987fe11780e",
"3715ef46-3aea-4ced-8ac8-027063598be5"
]
}
],
"StartDate": "2026-06-27T14:50:47.4979176+00:00",
"DueDate": "2026-06-27T14:50:47.4979176+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cdf157e6-61cd-4dc2-b0db-84bde4815ab9": "051c510c-c6fc-48da-ae47-1c8cdb97cacd",
"d63ad438-6a9e-45fb-8035-62ca853d401d": "b266130d-5961-48ce-8732-7456eadc35af"
},
"HasUpdates": true,
"Modified": "2026-06-27T14:50:47.4979176+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-06-27T14:50:47.4979176+00:00"
},
"LastComment": "2026-06-27T14:50:47.4979176+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "66dc7feb-0b1f-4416-86f9-42d0d14b9db1",
"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": "c39d997f-b9e6-4b01-b199-c437e15f9da5",
"id": "460869c1-5d3b-4a5e-a91d-c99559dc08ea",
"ConfigId": "f9a03673-0663-4d05-b05a-eba01a099e86"
}