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": "097ae331-da02-4925-a714-f78283dfb655",
"ParentTaskId": "7025e114-656e-49d0-a1ed-e3752f100af5",
"Integration": {
"IntegrationId": "109710e1-a54e-400f-a063-6759c56c7b50",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9e8dd0b6-499d-43cd-99cf-084afdd4d336": 2.0,
"e6aa1888-3480-4bf5-9eca-c592ac2c69f1": 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": "437ef0c3-e9f0-415a-83e6-ddf87582ab9a",
"Name": "sample string 1",
"Created": "2026-08-31T18:14:46.8297658+00:00",
"Modified": "2026-08-31T18:14:46.8297658+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e669b3e6-a284-4dcc-ae27-bef02e122168",
"7146d657-5e80-4ba0-9bbd-547bce8f8f54"
],
"NonLaborAssignments": [
{
"Id": "70d29e36-40cd-41b4-aa32-2f9f1e37917e",
"ResourceId": "b1dac313-98d6-4147-913e-2db2e3b7b8c9",
"Quantity": 3.0
},
{
"Id": "70d29e36-40cd-41b4-aa32-2f9f1e37917e",
"ResourceId": "b1dac313-98d6-4147-913e-2db2e3b7b8c9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a99ab08d-2a8e-4c3d-b74d-13e29e12fe46",
"Type": 0,
"ResourceId": "60433a63-1b3d-4d76-865e-ff2d025d69fb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "5141b85a-9a73-47d2-94f6-41ce6cc09815",
"Start": "2026-08-31T18:14:46.8297658+00:00",
"Due": "2026-08-31T18:14:46.8297658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "5141b85a-9a73-47d2-94f6-41ce6cc09815",
"Start": "2026-08-31T18:14:46.8297658+00:00",
"Due": "2026-08-31T18:14:46.8297658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "a99ab08d-2a8e-4c3d-b74d-13e29e12fe46",
"Type": 0,
"ResourceId": "60433a63-1b3d-4d76-865e-ff2d025d69fb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "5141b85a-9a73-47d2-94f6-41ce6cc09815",
"Start": "2026-08-31T18:14:46.8297658+00:00",
"Due": "2026-08-31T18:14:46.8297658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "5141b85a-9a73-47d2-94f6-41ce6cc09815",
"Start": "2026-08-31T18:14:46.8297658+00:00",
"Due": "2026-08-31T18:14:46.8297658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "2e6e2b45-8abc-4326-afee-c8c2d604bef7",
"WorkTypeParentId": "6baf6875-5c6b-4606-8e9f-0a07b3f328d0",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "725d2f91-8b18-493e-a427-036c10c25004",
"UPN": "e5edd279-97c3-40f5-9bfe-19d546a64467",
"PostDate": "2026-08-31T18:14:46.8297658+00:00",
"Comment": "sample string 4",
"CC": [
"4225168e-e3fb-4801-ac26-ca4176d33d7c",
"7010850e-54ac-4b50-9314-fa45b3ecb659"
],
"Users": [
"c1e910aa-238e-4e6d-979b-e3e7185fcf6e",
"1e461fa9-61ca-4a6d-891b-2f3cd35512d2"
]
},
{
"Id": "725d2f91-8b18-493e-a427-036c10c25004",
"UPN": "e5edd279-97c3-40f5-9bfe-19d546a64467",
"PostDate": "2026-08-31T18:14:46.8297658+00:00",
"Comment": "sample string 4",
"CC": [
"4225168e-e3fb-4801-ac26-ca4176d33d7c",
"7010850e-54ac-4b50-9314-fa45b3ecb659"
],
"Users": [
"c1e910aa-238e-4e6d-979b-e3e7185fcf6e",
"1e461fa9-61ca-4a6d-891b-2f3cd35512d2"
]
}
],
"StartDate": "2026-08-31T18:14:46.8297658+00:00",
"DueDate": "2026-08-31T18:14:46.8297658+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4ddb8e23-f802-4ae5-994b-2292b2c32ff5": "b374ba41-f982-4efa-a19e-f0a4fb71455d",
"ca244586-9177-4a36-b8cd-81cbd972056f": "64e3e1af-b1c7-4408-b2f4-905c4efac1cc"
},
"HasUpdates": true,
"Modified": "2026-08-31T18:14:46.8297658+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-31T18:14:46.8297658+00:00"
},
"LastComment": "2026-08-31T18:14:46.8297658+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "6b8cbd22-8b93-4f43-b17d-0640cb81e467",
"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": "33412970-cde4-400c-8b3a-30a9dc94b241",
"id": "cfd8d359-1ae3-4cdd-a30d-af3519470d6d",
"ConfigId": "70e99866-43d9-4024-9779-351658ae6287"
}