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": "82f0851d-4c83-4d34-9a47-e1558fc1762c",
"ParentTaskId": "6ee2865f-5308-4ae8-8e4a-a433200fd2c9",
"Integration": {
"IntegrationId": "639bc055-0177-468e-bfa5-4a7ec695bbd2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"eeb0ec69-8954-4361-b413-ac0a17378b46": 2.0,
"b025295c-9379-4785-82a3-52abff484962": 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": "8ac14402-6300-49eb-9761-d222dcf29d2a",
"Name": "sample string 1",
"Created": "2026-10-21T14:56:33.1114339+00:00",
"Modified": "2026-10-21T14:56:33.1114339+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"9634347a-5463-4fb4-bc1f-1639165c6e9a",
"bae77768-cc7e-43af-a1a8-5eab0e13bd07"
],
"NonLaborAssignments": [
{
"Id": "9c36ac9d-b542-4f32-bcc7-2b95c00ea398",
"ResourceId": "cb7da44a-d18e-458a-9fe9-69efbc6f687d",
"Quantity": 3.0
},
{
"Id": "9c36ac9d-b542-4f32-bcc7-2b95c00ea398",
"ResourceId": "cb7da44a-d18e-458a-9fe9-69efbc6f687d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a5c4aabf-144c-4f08-a782-482b10f3d41d",
"Type": 0,
"ResourceId": "203dc777-205c-43c6-be64-82124998864e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "bc01ba19-1203-4abd-b1c1-e6f82a565488",
"Start": "2026-10-21T14:56:33.1114339+00:00",
"Due": "2026-10-21T14:56:33.1114339+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "bc01ba19-1203-4abd-b1c1-e6f82a565488",
"Start": "2026-10-21T14:56:33.1114339+00:00",
"Due": "2026-10-21T14:56:33.1114339+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "a5c4aabf-144c-4f08-a782-482b10f3d41d",
"Type": 0,
"ResourceId": "203dc777-205c-43c6-be64-82124998864e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "bc01ba19-1203-4abd-b1c1-e6f82a565488",
"Start": "2026-10-21T14:56:33.1114339+00:00",
"Due": "2026-10-21T14:56:33.1114339+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "bc01ba19-1203-4abd-b1c1-e6f82a565488",
"Start": "2026-10-21T14:56:33.1114339+00:00",
"Due": "2026-10-21T14:56:33.1114339+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "c73b289f-833a-4349-a5d4-d52500843385",
"WorkTypeParentId": "8a8eca2f-00f2-4a96-8da4-8cfe8b8d4f65",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "041842e3-c4ad-4806-9230-833f5f4b5ddd",
"UPN": "aadc3372-6e48-41d1-8c10-04cc510d7218",
"PostDate": "2026-10-21T14:56:33.1114339+00:00",
"Comment": "sample string 4",
"CC": [
"dd28dbe6-d49d-4303-a17e-6c152c4bc9c2",
"39b24792-a271-4c7d-94f8-9fb31decfffe"
],
"Users": [
"954d7c81-d7f6-41b5-84c6-f22f3ff8210b",
"55bb8be9-ad5d-4669-824e-b505341aee50"
]
},
{
"Id": "041842e3-c4ad-4806-9230-833f5f4b5ddd",
"UPN": "aadc3372-6e48-41d1-8c10-04cc510d7218",
"PostDate": "2026-10-21T14:56:33.1114339+00:00",
"Comment": "sample string 4",
"CC": [
"dd28dbe6-d49d-4303-a17e-6c152c4bc9c2",
"39b24792-a271-4c7d-94f8-9fb31decfffe"
],
"Users": [
"954d7c81-d7f6-41b5-84c6-f22f3ff8210b",
"55bb8be9-ad5d-4669-824e-b505341aee50"
]
}
],
"StartDate": "2026-10-21T14:56:33.1114339+00:00",
"DueDate": "2026-10-21T14:56:33.1114339+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a5e75aca-d515-4cd0-b27d-04b0f37f106d": "a464acb2-2123-41d6-9c5d-e4aac09a8267",
"99f63281-d202-4fed-bbbc-e018c961e05e": "22ab538e-0e82-4a18-9b91-dbb459baf762"
},
"HasUpdates": true,
"Modified": "2026-10-21T14:56:33.1114339+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-10-21T14:56:33.1114339+00:00"
},
"LastComment": "2026-10-21T14:56:33.1114339+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "35534f8a-a014-487e-9203-00d18b6eff6c",
"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": "acd608f1-c59b-4065-873f-c5080a1c1102",
"id": "ad990e78-4256-4c92-9704-aec6afdc9455",
"ConfigId": "ca9365a1-5bc6-4df6-9482-a545b410053a"
}