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	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": "94fe7518-72e8-4a44-b35b-70562c45366b",
  "ParentTaskId": "5b7976b2-2f26-475a-895f-7b12a999fa35",
  "Integration": {
    "IntegrationId": "7f8781f3-ca4e-44ea-bc5c-b21673797f8b",
    "ExternalItemId": "sample string 2",
    "ExternalUrl": "sample string 3",
    "ReadOnlyFields": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Assignments": {
    "22e4cd83-b736-4971-88cd-a2855c7065e9": 2.0,
    "31ec671e-7dea-45ce-9086-cd576018443f": 4.0
  },
  "ProcessAssignments": true
}

Response Information

Resource Description

WorkPlanTask

Name	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": "3746c491-0faa-4a79-ba29-b05748bd51de",
  "Name": "sample string 1",
  "Created": "2025-09-03T18:16:25.7557903+00:00",
  "Modified": "2025-09-03T18:16:25.7557903+00:00",
  "Author": "sample string 4",
  "Editor": "sample string 5",
  "AssignedTo": [
    "5c6ae8c4-7e33-4f80-bc0c-909621630c2b",
    "cee7ec41-56d4-41f3-a3d7-f58ee52ce771"
  ],
  "NonLaborAssignments": [
    {
      "Id": "47702f6a-2202-40b2-b119-0167783019e5",
      "ResourceId": "068b362f-9ac7-425e-9a60-e6bdfe2cbe9e",
      "Quantity": 3.0
    },
    {
      "Id": "47702f6a-2202-40b2-b119-0167783019e5",
      "ResourceId": "068b362f-9ac7-425e-9a60-e6bdfe2cbe9e",
      "Quantity": 3.0
    }
  ],
  "Assignments": [
    {
      "Id": "a06e2656-d829-40f1-befc-ef2daab46884",
      "Type": 0,
      "ResourceId": "0b0fa4f6-14b6-4bb6-a4df-06bbb6fd6310",
      "Units": 3.0
    },
    {
      "Id": "a06e2656-d829-40f1-befc-ef2daab46884",
      "Type": 0,
      "ResourceId": "0b0fa4f6-14b6-4bb6-a4df-06bbb6fd6310",
      "Units": 3.0
    }
  ],
  "ParentId": "99cda99b-c318-485c-a8a7-961777696c8a",
  "WorkTypeParentId": "c2e649d0-b4f4-40e5-9baa-f621fb14c9d9",
  "WorkTypeIndex": 9,
  "Fields": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "Index": 10,
  "Complete": true,
  "Comments": [
    {
      "Id": "655b71ea-1bad-492d-a729-8b8f0cf06cb5",
      "UPN": "a2bae0a2-acb0-4468-9695-bd393ba71680",
      "PostDate": "2025-09-03T18:16:25.7557903+00:00",
      "Comment": "sample string 4",
      "CC": [
        "fbf8eb2c-fbc3-4dfe-91c0-89280c5a2bdf",
        "d447df67-22c3-4b7d-8d27-8ddcf02f7c12"
      ],
      "Users": [
        "300b7934-b74f-4c7c-a293-878e7ac0f6ad",
        "a9bfdd48-1244-4f5a-ae91-df53f8603d90"
      ]
    },
    {
      "Id": "655b71ea-1bad-492d-a729-8b8f0cf06cb5",
      "UPN": "a2bae0a2-acb0-4468-9695-bd393ba71680",
      "PostDate": "2025-09-03T18:16:25.7557903+00:00",
      "Comment": "sample string 4",
      "CC": [
        "fbf8eb2c-fbc3-4dfe-91c0-89280c5a2bdf",
        "d447df67-22c3-4b7d-8d27-8ddcf02f7c12"
      ],
      "Users": [
        "300b7934-b74f-4c7c-a293-878e7ac0f6ad",
        "a9bfdd48-1244-4f5a-ae91-df53f8603d90"
      ]
    }
  ],
  "StartDate": "2025-09-03T18:16:25.7557903+00:00",
  "DueDate": "2025-09-03T18:16:25.7557903+00:00",
  "TaskScheduleType": 0,
  "StatusUpdate": {
    "ResourceReplacements": {
      "25afc500-2004-4c57-9673-f540de01560a": "08fe9861-9f0f-4970-b486-a8bedb769ce7",
      "75fc8e8f-ac05-4578-ab2d-17c197d33c44": "8f0321fa-d2b5-46c9-9b1d-dba0409040c6"
    },
    "HasUpdates": true,
    "Modified": "2025-09-03T18:16:25.7557903+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": "2025-09-03T18:16:25.7557903+00:00"
  },
  "LastComment": "2025-09-03T18:16:25.7557903+00:00",
  "IsScheduled": true,
  "Integration": {
    "IntegrationId": "f7920f7a-2790-4707-820d-8ca1f74c7270",
    "ExternalItemId": "sample string 2",
    "ExternalUrl": "sample string 3",
    "ReadOnlyFields": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "WorkPlanId": "0f2999bb-af7f-4c65-9073-1f8ca21657d7",
  "id": "86b8aae0-64b2-4df5-b1ed-c8cc4263bb7f",
  "ConfigId": "01cb9b99-8e80-4110-b66a-fa335dd8e26e"
}