GET api/Planning/Data?projectId={projectId}&spaceId={spaceId}&roadmapMode={roadmapMode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
projectId

integer

Required

spaceId

integer

Required

roadmapMode

integer

Default value is 0

Body Parameters

None.

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-07-16 13:39:27",
        "End": "2024-07-16 13:39:27",
        "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-07-16 13:39:27",
        "End": "2024-07-16 13:39:27",
        "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-07-16T13:39:27.0675061-07: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-07-16T13:39:27.0675061-07: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-07-16T13:39:27.0675061-07: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-07-16T13:39:27.0675061-07: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>