POST api/Planning/WorkData

Request Information

URI Parameters

None.

Body Parameters

PlanningWorkItemQuery
NameDescriptionTypeAdditional information
ProjectId

integer

None.
FolderId

integer

None.
RoadmapOptions

integer

None.
StartTime

date

None.
EndTime

date

None.
TypeId

Collection of integer

None.
StartIndex

integer

None.
PageSize

integer

None.
ProjectType

integer

None.
AllFolders

Collection of integer

None.
RoadmapMonth

integer

None.
CompletedOptions

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "FolderId": 2,
  "RoadmapOptions": 3,
  "StartTime": "2024-12-21 19:18:16",
  "EndTime": "2024-12-21 19:18:16",
  "TypeId": [
    1,
    2
  ],
  "StartIndex": 4,
  "PageSize": 5,
  "ProjectType": 6,
  "AllFolders": [
    1,
    2
  ],
  "RoadmapMonth": 7,
  "CompletedOptions": 8
}

application/xml, text/xml

Sample: 
<PlanningWorkItemQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Planning">
  <AllFolders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AllFolders>
  <CompletedOptions>8</CompletedOptions>
  <EndTime>2024-12-21T19:18:16.4949756-08:00</EndTime>
  <FolderId>2</FolderId>
  <PageSize>5</PageSize>
  <ProjectId>1</ProjectId>
  <ProjectType>6</ProjectType>
  <RoadmapMonth>7</RoadmapMonth>
  <RoadmapOptions>3</RoadmapOptions>
  <StartIndex>4</StartIndex>
  <StartTime>2024-12-21T19:18:16.4949756-08:00</StartTime>
  <TypeId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TypeId>
</PlanningWorkItemQuery>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

API_Data_PlanningData
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

PlanningData

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "Items": [
      {
        "ParentId": "sample string 1",
        "OrderId": 2,
        "Start": "2024-12-21 19:18:16",
        "End": "2024-12-21 19:18:16",
        "Title": "sample string 3",
        "IsExpanded": true,
        "IsSummary": true,
        "TypeId": 6,
        "PercentCompleted": 7,
        "Access": 8,
        "IsLeaf": true,
        "IsControl": false,
        "IsClosed": true,
        "SprintState": 11,
        "WorkItemCount": 12,
        "IconRefer": 13,
        "Completed": 14.1,
        "ProjectId": 16,
        "ProjectType": 17,
        "ItemId": 18,
        "ItemType": 19,
        "Id": "16(17)-18(19)",
        "IsWorkItem": false
      },
      {
        "ParentId": "sample string 1",
        "OrderId": 2,
        "Start": "2024-12-21 19:18:16",
        "End": "2024-12-21 19:18:16",
        "Title": "sample string 3",
        "IsExpanded": true,
        "IsSummary": true,
        "TypeId": 6,
        "PercentCompleted": 7,
        "Access": 8,
        "IsLeaf": true,
        "IsControl": false,
        "IsClosed": true,
        "SprintState": 11,
        "WorkItemCount": 12,
        "IconRefer": 13,
        "Completed": 14.1,
        "ProjectId": 16,
        "ProjectType": 17,
        "ItemId": 18,
        "ItemType": 19,
        "Id": "16(17)-18(19)",
        "IsWorkItem": false
      }
    ],
    "Dependencies": [
      {
        "ProjectId": 1,
        "ProjectType": 2,
        "FromItemId": 3,
        "FromItemType": 4,
        "FromId": "1(2)-3(4)",
        "ToItemId": 5,
        "ToItemType": 6,
        "ToId": "1(2)-5(6)",
        "Id": "[1(2)-3(4)]->[1(2)-5(6)]",
        "Type": 7,
        "Lag": 8,
        "IsWorkItem": true
      },
      {
        "ProjectId": 1,
        "ProjectType": 2,
        "FromItemId": 3,
        "FromItemType": 4,
        "FromId": "1(2)-3(4)",
        "ToItemId": 5,
        "ToItemType": 6,
        "ToId": "1(2)-5(6)",
        "Id": "[1(2)-3(4)]->[1(2)-5(6)]",
        "Type": 7,
        "Lag": 8,
        "IsWorkItem": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<API_Data_PlanningData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Planning">
    <d2p1:Dependencies>
      <d2p1:PlanningDependency>
        <d2p1:FromItemId>3</d2p1:FromItemId>
        <d2p1:FromItemType>4</d2p1:FromItemType>
        <d2p1:Lag>8</d2p1:Lag>
        <d2p1:ProjectId>1</d2p1:ProjectId>
        <d2p1:ProjectType>2</d2p1:ProjectType>
        <d2p1:ToItemId>5</d2p1:ToItemId>
        <d2p1:ToItemType>6</d2p1:ToItemType>
        <d2p1:Type>7</d2p1:Type>
      </d2p1:PlanningDependency>
      <d2p1:PlanningDependency>
        <d2p1:FromItemId>3</d2p1:FromItemId>
        <d2p1:FromItemType>4</d2p1:FromItemType>
        <d2p1:Lag>8</d2p1:Lag>
        <d2p1:ProjectId>1</d2p1:ProjectId>
        <d2p1:ProjectType>2</d2p1:ProjectType>
        <d2p1:ToItemId>5</d2p1:ToItemId>
        <d2p1:ToItemType>6</d2p1:ToItemType>
        <d2p1:Type>7</d2p1:Type>
      </d2p1:PlanningDependency>
    </d2p1:Dependencies>
    <d2p1:Items>
      <d2p1:PlanningItem>
        <d2p1:ItemId>18</d2p1:ItemId>
        <d2p1:ItemType>19</d2p1:ItemType>
        <d2p1:ProjectId>16</d2p1:ProjectId>
        <d2p1:ProjectType>17</d2p1:ProjectType>
        <d2p1:Access>8</d2p1:Access>
        <d2p1:Completed>14.1</d2p1:Completed>
        <d2p1:End>2024-12-21T19:18:16.4949756-08:00</d2p1:End>
        <d2p1:IconRefer>13</d2p1:IconRefer>
        <d2p1:IsClosed>true</d2p1:IsClosed>
        <d2p1:IsExpanded>true</d2p1:IsExpanded>
        <d2p1:IsLeaf>true</d2p1:IsLeaf>
        <d2p1:IsSummary>true</d2p1:IsSummary>
        <d2p1:OrderId>2</d2p1:OrderId>
        <d2p1:ParentId>sample string 1</d2p1:ParentId>
        <d2p1:PercentCompleted>7</d2p1:PercentCompleted>
        <d2p1:SprintState>11</d2p1:SprintState>
        <d2p1:Start>2024-12-21T19:18:16.4949756-08:00</d2p1:Start>
        <d2p1:Title>sample string 3</d2p1:Title>
        <d2p1:TypeId>6</d2p1:TypeId>
        <d2p1:WorkItemCount>12</d2p1:WorkItemCount>
        <d2p1:WorkParentId>15</d2p1:WorkParentId>
      </d2p1:PlanningItem>
      <d2p1:PlanningItem>
        <d2p1:ItemId>18</d2p1:ItemId>
        <d2p1:ItemType>19</d2p1:ItemType>
        <d2p1:ProjectId>16</d2p1:ProjectId>
        <d2p1:ProjectType>17</d2p1:ProjectType>
        <d2p1:Access>8</d2p1:Access>
        <d2p1:Completed>14.1</d2p1:Completed>
        <d2p1:End>2024-12-21T19:18:16.4949756-08:00</d2p1:End>
        <d2p1:IconRefer>13</d2p1:IconRefer>
        <d2p1:IsClosed>true</d2p1:IsClosed>
        <d2p1:IsExpanded>true</d2p1:IsExpanded>
        <d2p1:IsLeaf>true</d2p1:IsLeaf>
        <d2p1:IsSummary>true</d2p1:IsSummary>
        <d2p1:OrderId>2</d2p1:OrderId>
        <d2p1:ParentId>sample string 1</d2p1:ParentId>
        <d2p1:PercentCompleted>7</d2p1:PercentCompleted>
        <d2p1:SprintState>11</d2p1:SprintState>
        <d2p1:Start>2024-12-21T19:18:16.4949756-08:00</d2p1:Start>
        <d2p1:Title>sample string 3</d2p1:Title>
        <d2p1:TypeId>6</d2p1:TypeId>
        <d2p1:WorkItemCount>12</d2p1:WorkItemCount>
        <d2p1:WorkParentId>15</d2p1:WorkParentId>
      </d2p1:PlanningItem>
    </d2p1:Items>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_PlanningData>