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": "6d044a29-c90f-4ea9-a928-c309e8caf8e7",
"ParentTaskId": "224b4878-20c0-4d31-8d66-25abad6f0a5b",
"Integration": {
"IntegrationId": "5c8ba626-a431-47e7-a22b-7eb35411b5c2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"48492779-3322-43c3-a771-5f8e43a7ac2f": 2.0,
"384dec52-b9a0-469f-a368-ee41538f1cd5": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "03d58d96-5fb9-436c-a499-cbab6d5531cb",
"Name": "sample string 1",
"Created": "2026-02-20T15:01:05.0953542+00:00",
"Modified": "2026-02-20T15:01:05.0953542+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"a9007dd2-6144-467e-a7a0-ef6a87ce74a6",
"39193580-10f6-4338-ba8f-19e894c659b0"
],
"NonLaborAssignments": [
{
"Id": "70f2c006-e952-4b14-ab58-1435371fd0d7",
"ResourceId": "6938236a-98e7-4f0f-abc7-e577249ce68c",
"Quantity": 3.0
},
{
"Id": "70f2c006-e952-4b14-ab58-1435371fd0d7",
"ResourceId": "6938236a-98e7-4f0f-abc7-e577249ce68c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b0c88836-d475-4d35-8657-d9479d47a686",
"Type": 0,
"ResourceId": "01932396-e72b-4937-89fe-a43acc2fb8dd",
"Units": 3.0
},
{
"Id": "b0c88836-d475-4d35-8657-d9479d47a686",
"Type": 0,
"ResourceId": "01932396-e72b-4937-89fe-a43acc2fb8dd",
"Units": 3.0
}
],
"ParentId": "5a9efdf7-fe15-4b6b-a2e3-d90f2da6132d",
"WorkTypeParentId": "6f103a31-7eca-484e-bafe-bb88e34c5a33",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3a160ced-3831-4f50-9fec-2051977c3d6a",
"UPN": "fd001784-b41d-4f54-8029-cb40aa32c3c2",
"PostDate": "2026-02-20T15:01:05.0953542+00:00",
"Comment": "sample string 4",
"CC": [
"ea4179a7-d68d-4966-be96-77fe827baf62",
"4b966c94-15bd-4d96-8f46-3ffbcf56d6fc"
],
"Users": [
"f68f2c03-78f8-4fd7-8151-735a3901247c",
"b831a9a0-5cae-4ba6-b66e-0a34ec2f6db9"
]
},
{
"Id": "3a160ced-3831-4f50-9fec-2051977c3d6a",
"UPN": "fd001784-b41d-4f54-8029-cb40aa32c3c2",
"PostDate": "2026-02-20T15:01:05.0953542+00:00",
"Comment": "sample string 4",
"CC": [
"ea4179a7-d68d-4966-be96-77fe827baf62",
"4b966c94-15bd-4d96-8f46-3ffbcf56d6fc"
],
"Users": [
"f68f2c03-78f8-4fd7-8151-735a3901247c",
"b831a9a0-5cae-4ba6-b66e-0a34ec2f6db9"
]
}
],
"StartDate": "2026-02-20T15:01:05.0953542+00:00",
"DueDate": "2026-02-20T15:01:05.0953542+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a6f2dfdd-07e6-465e-8bc7-d9739b7565ab": "917b8a88-54df-4fe5-a8c3-81ad288fc30b",
"d739779b-65ec-4165-8b7f-781c10046831": "fe72b2ad-7449-4b56-a44e-3e2e8ba99119"
},
"HasUpdates": true,
"Modified": "2026-02-20T15:01:05.0953542+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-02-20T15:01:05.0953542+00:00"
},
"LastComment": "2026-02-20T15:01:05.0953542+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "debc7798-9087-45fc-b6cd-b95183bd2efe",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "c1d0a065-14aa-498a-ad25-3cde9e16c84c",
"id": "b548c730-4874-4b0a-ae90-2ea3ef97e7eb",
"ConfigId": "b9786bf8-6673-4ff6-97cc-1b0071df26a9"
}