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": "4f056358-df60-4547-ad4e-138a75a6688e",
"ParentTaskId": "6494eebe-d388-433b-a5d4-4bfc66988a9e",
"Integration": {
"IntegrationId": "332e28c5-c9d4-40e4-b9bf-a8c8e89a9d9f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"64e516fd-79ad-482b-8a9c-67abac0878af": 2.0,
"5c09c069-2919-4af1-b1c3-0a6799cd655f": 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": "1fe90508-4d94-430c-a467-5962d04e5354",
"Name": "sample string 1",
"Created": "2026-08-06T19:54:01.7278053+00:00",
"Modified": "2026-08-06T19:54:01.7278053+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7a391b60-0994-488d-b394-d7f9179d874f",
"606d932f-598d-4fed-92cb-de41137f9133"
],
"NonLaborAssignments": [
{
"Id": "90c31ade-d491-4657-a8f7-db435e01472a",
"ResourceId": "f67c5314-8811-49ad-8c78-67291d4e855b",
"Quantity": 3.0
},
{
"Id": "90c31ade-d491-4657-a8f7-db435e01472a",
"ResourceId": "f67c5314-8811-49ad-8c78-67291d4e855b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "365b08b9-c719-452f-930e-1fcadbf9b786",
"Type": 0,
"ResourceId": "468ff43f-28f8-4efb-b775-5472e8a514fe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "365b08b9-c719-452f-930e-1fcadbf9b786",
"Type": 0,
"ResourceId": "468ff43f-28f8-4efb-b775-5472e8a514fe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "910b4068-9736-410c-aba1-bc9e8139b0cf",
"WorkTypeParentId": "bf3f476a-617b-4fec-8b02-97ae3cd2f921",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ce6efb28-2d40-45a1-9ea8-14ea41cd9468",
"UPN": "a5784304-e416-4ef5-9e04-f91754ffce99",
"PostDate": "2026-08-06T19:54:01.7278053+00:00",
"Comment": "sample string 4",
"CC": [
"e565bb92-e0b4-4d85-b643-ac1a6b78a005",
"6e33529b-0a33-4bbc-9b3c-01e036557065"
],
"Users": [
"2ea78c98-65cf-4a7d-a581-941906764521",
"1df1275b-1766-43f0-b000-eb50785fb16a"
]
},
{
"Id": "ce6efb28-2d40-45a1-9ea8-14ea41cd9468",
"UPN": "a5784304-e416-4ef5-9e04-f91754ffce99",
"PostDate": "2026-08-06T19:54:01.7278053+00:00",
"Comment": "sample string 4",
"CC": [
"e565bb92-e0b4-4d85-b643-ac1a6b78a005",
"6e33529b-0a33-4bbc-9b3c-01e036557065"
],
"Users": [
"2ea78c98-65cf-4a7d-a581-941906764521",
"1df1275b-1766-43f0-b000-eb50785fb16a"
]
}
],
"StartDate": "2026-08-06T19:54:01.7278053+00:00",
"DueDate": "2026-08-06T19:54:01.7278053+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3e281427-452a-4fe4-ac5a-acc915de8438": "93364733-8e9c-4c30-adf0-ccfe5f3f3ef3",
"b78ba61d-e802-48f3-85ba-ca30663d1c0e": "77a752c6-3146-4af9-9e49-6f4bf99ea61c"
},
"HasUpdates": true,
"Modified": "2026-08-06T19:54:01.7278053+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-06T19:54:01.7278053+00:00"
},
"LastComment": "2026-08-06T19:54:01.7278053+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "17cc133a-3015-4d04-9bc9-4858b514da7c",
"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": "a6464f86-c4b9-4fe3-aa0e-005e55913dab",
"id": "53304c19-7f88-485c-8ec8-0c77301a96d0",
"ConfigId": "a6d74b19-f0ee-4eef-8a09-efcb7b5052e0"
}