POST api/Planning/Item

Request Information

URI Parameters

None.

Body Parameters

PlanningItemBase
NameDescriptionTypeAdditional information
ProjectId

integer

None.

ProjectType

integer

None.

ItemId

integer

None.

ItemType

integer

None.

Id

string

None.

IsWorkItem

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ProjectId": 1,
  "ProjectType": 2,
  "ItemId": 3,
  "ItemType": 4,
  "Id": "1(2)-3(4)",
  "IsWorkItem": true
}

application/xml, text/xml

Sample:
<PlanningItemBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Planning">
  <ItemId>3</ItemId>
  <ItemType>4</ItemType>
  <ProjectId>1</ProjectId>
  <ProjectType>2</ProjectType>
</PlanningItemBase>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

API_Data_PlanningItem
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

PlanningItem

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "ParentId": "sample string 1",
    "OrderId": 2,
    "Start": "2024-07-14 08:57:44",
    "End": "2024-07-14 08:57:44",
    "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
  }
}

application/xml, text/xml

Sample:
<API_Data_PlanningItem 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: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-14T08:57:44.829083-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-14T08:57:44.829083-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>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_PlanningItem>