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": "e777963f-d87b-4d90-8f18-17c0de65ee98",
"ParentTaskId": "8ba16e32-f68f-412d-8f18-7c5b366aaa64",
"Integration": {
"IntegrationId": "e29f7b06-ec1d-4187-b244-4fb38788d195",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9bf3869f-3656-4950-a20a-ff7823721eae": 2.0,
"b9ef3b40-e2dc-4ff6-ad58-000f56f349b2": 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": "236cad15-109b-4a05-9cf5-041f63712037",
"Name": "sample string 1",
"Created": "2026-05-16T04:15:00.1390267+00:00",
"Modified": "2026-05-16T04:15:00.1390267+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0bbc6d81-9936-475c-a58a-e7afc1f46d5f",
"3dad8f4b-edd1-4de3-8d0f-7294f8525c57"
],
"NonLaborAssignments": [
{
"Id": "cd3eb913-38c2-476d-acd1-50a303c40601",
"ResourceId": "9b8067c1-8f90-4a46-b2c9-f99831a7b587",
"Quantity": 3.0
},
{
"Id": "cd3eb913-38c2-476d-acd1-50a303c40601",
"ResourceId": "9b8067c1-8f90-4a46-b2c9-f99831a7b587",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "29155a1a-d19a-48bb-b928-c5ada1e17a3a",
"Type": 0,
"ResourceId": "fc687ccd-253a-4169-a2a5-205b17097def",
"Units": 3.0
},
{
"Id": "29155a1a-d19a-48bb-b928-c5ada1e17a3a",
"Type": 0,
"ResourceId": "fc687ccd-253a-4169-a2a5-205b17097def",
"Units": 3.0
}
],
"ParentId": "fdb06c2f-d2b1-4180-b1f6-1f2c6d99416f",
"WorkTypeParentId": "ea28d997-d780-4704-9a6f-e81797369d0b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "10e904a7-3d6f-4b2f-adfc-62e73a2cc63c",
"UPN": "c560e422-83e6-471a-99d4-d61b55b06d9a",
"PostDate": "2026-05-16T04:15:00.1390267+00:00",
"Comment": "sample string 4",
"CC": [
"e709dbda-e96a-47f9-b8b6-f08c3b53f6fd",
"d6c9ced7-4110-4ee3-aa5f-f7532e9aa10b"
],
"Users": [
"5b0e1c4f-ae06-4204-861e-fe3db15581cd",
"2d796c10-aaab-4092-80f4-bc9400f65fd8"
]
},
{
"Id": "10e904a7-3d6f-4b2f-adfc-62e73a2cc63c",
"UPN": "c560e422-83e6-471a-99d4-d61b55b06d9a",
"PostDate": "2026-05-16T04:15:00.1390267+00:00",
"Comment": "sample string 4",
"CC": [
"e709dbda-e96a-47f9-b8b6-f08c3b53f6fd",
"d6c9ced7-4110-4ee3-aa5f-f7532e9aa10b"
],
"Users": [
"5b0e1c4f-ae06-4204-861e-fe3db15581cd",
"2d796c10-aaab-4092-80f4-bc9400f65fd8"
]
}
],
"StartDate": "2026-05-16T04:15:00.1390267+00:00",
"DueDate": "2026-05-16T04:15:00.1390267+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e8a11aea-3135-4319-84bb-27c0ba53a00f": "6e191e57-c91c-4199-a4da-669bc7eec9bf",
"50829ec0-86b0-46c7-a6c0-445e2d8c8f11": "c9c68935-a36d-4b0c-971f-4186f47bd749"
},
"HasUpdates": true,
"Modified": "2026-05-16T04:15:00.1390267+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-05-16T04:15:00.1390267+00:00"
},
"LastComment": "2026-05-16T04:15:00.1390267+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1ef88bbf-2f8f-4e4e-b68a-ad475ad16699",
"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": "f206ffa5-47f5-4113-be44-65154fd8218c",
"id": "63110d75-5c5e-474f-994c-d3d5703bfc87",
"ConfigId": "ee462237-50e2-4db7-a92d-cf8be503be64"
}