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": "7c74792b-dabd-42a1-8e2c-59f51a44cd0d",
"ParentTaskId": "90c58b6d-7ca2-4e4d-9ac0-47bfd13866e3",
"Integration": {
"IntegrationId": "54ffc07f-8504-4515-b460-33e13622789f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"faabea22-ce03-42e0-9f9c-f586a71111ff": 2.0,
"fc515425-7b4c-4895-811a-35e0091cddad": 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": "30a40dac-3b19-4a55-8a16-5edca723cbbc",
"Name": "sample string 1",
"Created": "2026-04-15T05:25:00.4960209+00:00",
"Modified": "2026-04-15T05:25:00.4960209+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e3ead84b-9d7c-457c-865f-d0caff7e948a",
"d75b2006-13bd-426b-9d5f-bb72e3bc0f0d"
],
"NonLaborAssignments": [
{
"Id": "695e2adb-fe53-4d13-97e0-b1490bfe8e3b",
"ResourceId": "57c64468-a4c4-4912-8632-d2e2d21415b2",
"Quantity": 3.0
},
{
"Id": "695e2adb-fe53-4d13-97e0-b1490bfe8e3b",
"ResourceId": "57c64468-a4c4-4912-8632-d2e2d21415b2",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "eabc73ef-4c35-4aa7-9a5f-6f2b93b612f0",
"Type": 0,
"ResourceId": "014979a5-7aad-464b-95b3-eeb928406b9f",
"Units": 3.0
},
{
"Id": "eabc73ef-4c35-4aa7-9a5f-6f2b93b612f0",
"Type": 0,
"ResourceId": "014979a5-7aad-464b-95b3-eeb928406b9f",
"Units": 3.0
}
],
"ParentId": "dec5266c-dad2-444d-8996-259b2ee2e0a8",
"WorkTypeParentId": "68c6edec-56a2-4921-b8ab-8898c14cc39c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "baa972bb-d149-4399-80ee-75ebc60f1573",
"UPN": "6a9b041f-2bf6-4a2a-8ffc-ad6e33884c6d",
"PostDate": "2026-04-15T05:25:00.4960209+00:00",
"Comment": "sample string 4",
"CC": [
"7dc77687-ab14-4099-9dc2-e4f80deb9ac7",
"b44aea10-d3c5-4f76-9b81-c7c305c612d3"
],
"Users": [
"fb5cf6c9-27b3-4f4d-a535-fe068b050d7f",
"22b6a373-8e13-4831-830a-95f67e7103df"
]
},
{
"Id": "baa972bb-d149-4399-80ee-75ebc60f1573",
"UPN": "6a9b041f-2bf6-4a2a-8ffc-ad6e33884c6d",
"PostDate": "2026-04-15T05:25:00.4960209+00:00",
"Comment": "sample string 4",
"CC": [
"7dc77687-ab14-4099-9dc2-e4f80deb9ac7",
"b44aea10-d3c5-4f76-9b81-c7c305c612d3"
],
"Users": [
"fb5cf6c9-27b3-4f4d-a535-fe068b050d7f",
"22b6a373-8e13-4831-830a-95f67e7103df"
]
}
],
"StartDate": "2026-04-15T05:25:00.4960209+00:00",
"DueDate": "2026-04-15T05:25:00.4960209+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cb215627-eb48-4514-8004-650e6c19110d": "85ae11eb-18c3-449b-ae8e-eda2cd07356b",
"f9cbca95-bcf6-414a-9585-09282bdd21da": "5ba4262f-69dd-47e7-9c94-59e58d9a7f69"
},
"HasUpdates": true,
"Modified": "2026-04-15T05:25:00.4960209+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-04-15T05:25:00.4960209+00:00"
},
"LastComment": "2026-04-15T05:25:00.4960209+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "59278c7f-9d4a-4ebf-bf3e-1e8a646ed890",
"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": "3e9afc4f-c114-43e0-8e5b-d15bf642bd5e",
"id": "3a983166-d042-4d5e-87c8-3a9e79b27f08",
"ConfigId": "2c44dbc0-14fb-4795-999e-e599b44dec25"
}