GET api/workplan/{id}/tasks?HasUpdates={HasUpdates}&FilterField={FilterField}&FilterValue={FilterValue}

Get tasks for a plan

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required
HasUpdates

boolean

None.
FilterField

string

Default value is

FilterValue

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of WorkPlanTask
NameDescriptionTypeAdditional 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.
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": "5f73b458-0c4d-4e6e-9592-3cdfb2007251",
    "Name": "sample string 1",
    "Created": "2024-12-18T19:45:39.3425728+00:00",
    "Modified": "2024-12-18T19:45:39.3425728+00:00",
    "Author": "sample string 4",
    "Editor": "sample string 5",
    "AssignedTo": [
      "44731cfb-9ebe-429e-b012-3f3cce0cc5f8",
      "41a4655c-ee1e-43a6-973b-e6c62589bc18"
    ],
    "Assignments": [
      {
        "Id": "8ef3ffc2-732d-494f-b615-cd52f97de6b9",
        "Type": 0,
        "ResourceId": "dd0f802b-d6fe-49b5-bba2-99c972ec0a34",
        "Units": 3.0
      },
      {
        "Id": "8ef3ffc2-732d-494f-b615-cd52f97de6b9",
        "Type": 0,
        "ResourceId": "dd0f802b-d6fe-49b5-bba2-99c972ec0a34",
        "Units": 3.0
      }
    ],
    "ParentId": "10a8b043-69ca-4697-9de0-e250fbce46b9",
    "WorkTypeParentId": "7a7ed8b4-3908-4672-a5da-ed970a62be74",
    "WorkTypeIndex": 9,
    "Fields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "Index": 10,
    "Complete": true,
    "Comments": [
      {
        "Id": "d9e2ac27-a669-4069-a430-8eab965f947e",
        "UPN": "ea248365-4d25-47b7-826b-dfbd4f5d22b5",
        "PostDate": "2024-12-18T19:45:39.3425728+00:00",
        "Comment": "sample string 4",
        "CC": [
          "15c8656c-615a-4dcc-a6d4-74fe4b024e9a",
          "f2a0d878-d0a1-49e6-b371-19ab7c433319"
        ],
        "Users": [
          "d05008b5-56b9-4cb2-b58d-61ab39e55ac4",
          "48b30817-9383-49a1-b499-60a8edf6ce5b"
        ]
      },
      {
        "Id": "d9e2ac27-a669-4069-a430-8eab965f947e",
        "UPN": "ea248365-4d25-47b7-826b-dfbd4f5d22b5",
        "PostDate": "2024-12-18T19:45:39.3425728+00:00",
        "Comment": "sample string 4",
        "CC": [
          "15c8656c-615a-4dcc-a6d4-74fe4b024e9a",
          "f2a0d878-d0a1-49e6-b371-19ab7c433319"
        ],
        "Users": [
          "d05008b5-56b9-4cb2-b58d-61ab39e55ac4",
          "48b30817-9383-49a1-b499-60a8edf6ce5b"
        ]
      }
    ],
    "StartDate": "2024-12-18T19:45:39.3425728+00:00",
    "DueDate": "2024-12-18T19:45:39.3425728+00:00",
    "TaskScheduleType": 0,
    "StatusUpdate": {
      "ResourceReplacements": {
        "50aea6cb-71d9-431e-a06f-3ea1b52b1694": "86b60ede-46b6-4fa9-8c67-6574ea83fd7f",
        "06c3d2a5-6ed9-46a9-97ee-03b773a2e683": "d16af821-8633-4bd9-9978-aedc04681831"
      },
      "HasUpdates": true,
      "Modified": "2024-12-18T19:45:39.3425728+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": "2024-12-18T19:45:39.3425728+00:00"
    },
    "LastComment": "2024-12-18T19:45:39.3425728+00:00",
    "IsScheduled": true,
    "Integration": {
      "IntegrationId": "3896b607-72d4-4456-bf69-bc390183c83f",
      "ExternalItemId": "sample string 2",
      "ExternalUrl": "sample string 3",
      "ReadOnlyFields": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "WorkPlanId": "07599b5d-d1cb-4b03-a233-3ab373957eb7",
    "id": "699d039d-b80b-4b9d-b7a5-449a6789e2ea",
    "ConfigId": "5c4d4aea-c42b-47e0-aa47-08ced4a5a3c2"
  },
  {
    "WorkTypeId": "5f73b458-0c4d-4e6e-9592-3cdfb2007251",
    "Name": "sample string 1",
    "Created": "2024-12-18T19:45:39.3425728+00:00",
    "Modified": "2024-12-18T19:45:39.3425728+00:00",
    "Author": "sample string 4",
    "Editor": "sample string 5",
    "AssignedTo": [
      "44731cfb-9ebe-429e-b012-3f3cce0cc5f8",
      "41a4655c-ee1e-43a6-973b-e6c62589bc18"
    ],
    "Assignments": [
      {
        "Id": "8ef3ffc2-732d-494f-b615-cd52f97de6b9",
        "Type": 0,
        "ResourceId": "dd0f802b-d6fe-49b5-bba2-99c972ec0a34",
        "Units": 3.0
      },
      {
        "Id": "8ef3ffc2-732d-494f-b615-cd52f97de6b9",
        "Type": 0,
        "ResourceId": "dd0f802b-d6fe-49b5-bba2-99c972ec0a34",
        "Units": 3.0
      }
    ],
    "ParentId": "10a8b043-69ca-4697-9de0-e250fbce46b9",
    "WorkTypeParentId": "7a7ed8b4-3908-4672-a5da-ed970a62be74",
    "WorkTypeIndex": 9,
    "Fields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "Index": 10,
    "Complete": true,
    "Comments": [
      {
        "Id": "d9e2ac27-a669-4069-a430-8eab965f947e",
        "UPN": "ea248365-4d25-47b7-826b-dfbd4f5d22b5",
        "PostDate": "2024-12-18T19:45:39.3425728+00:00",
        "Comment": "sample string 4",
        "CC": [
          "15c8656c-615a-4dcc-a6d4-74fe4b024e9a",
          "f2a0d878-d0a1-49e6-b371-19ab7c433319"
        ],
        "Users": [
          "d05008b5-56b9-4cb2-b58d-61ab39e55ac4",
          "48b30817-9383-49a1-b499-60a8edf6ce5b"
        ]
      },
      {
        "Id": "d9e2ac27-a669-4069-a430-8eab965f947e",
        "UPN": "ea248365-4d25-47b7-826b-dfbd4f5d22b5",
        "PostDate": "2024-12-18T19:45:39.3425728+00:00",
        "Comment": "sample string 4",
        "CC": [
          "15c8656c-615a-4dcc-a6d4-74fe4b024e9a",
          "f2a0d878-d0a1-49e6-b371-19ab7c433319"
        ],
        "Users": [
          "d05008b5-56b9-4cb2-b58d-61ab39e55ac4",
          "48b30817-9383-49a1-b499-60a8edf6ce5b"
        ]
      }
    ],
    "StartDate": "2024-12-18T19:45:39.3425728+00:00",
    "DueDate": "2024-12-18T19:45:39.3425728+00:00",
    "TaskScheduleType": 0,
    "StatusUpdate": {
      "ResourceReplacements": {
        "50aea6cb-71d9-431e-a06f-3ea1b52b1694": "86b60ede-46b6-4fa9-8c67-6574ea83fd7f",
        "06c3d2a5-6ed9-46a9-97ee-03b773a2e683": "d16af821-8633-4bd9-9978-aedc04681831"
      },
      "HasUpdates": true,
      "Modified": "2024-12-18T19:45:39.3425728+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": "2024-12-18T19:45:39.3425728+00:00"
    },
    "LastComment": "2024-12-18T19:45:39.3425728+00:00",
    "IsScheduled": true,
    "Integration": {
      "IntegrationId": "3896b607-72d4-4456-bf69-bc390183c83f",
      "ExternalItemId": "sample string 2",
      "ExternalUrl": "sample string 3",
      "ReadOnlyFields": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "WorkPlanId": "07599b5d-d1cb-4b03-a233-3ab373957eb7",
    "id": "699d039d-b80b-4b9d-b7a5-449a6789e2ea",
    "ConfigId": "5c4d4aea-c42b-47e0-aa47-08ced4a5a3c2"
  }
]