POST api/Story/Update

Update a story based on story item id.

Request Information

URI Parameters

None.

Body Parameters

StoryUpdateBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.
StoryId

integer

None.
StoryTitle

string

None.
Description

Only standalone story's description can be updated.

 string

None.
CurrentStatus

integer

None.
SubProjectId

integer

None.
StoryPriority

integer

None.
StoryPoints

integer

None.
StoryEstimatedTime

integer

None.
CurrentOwnerId

integer

None.
TaskBoardFolderId

integer

None.
WorkObjective

integer

None.
PlanedStartDate

date

None.
PlanedEndDate

date

None.
StoryType

integer

None.
WorkType

integer

None.
ActualStoryPoints

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "StoryId": 2,
  "StoryTitle": "sample string 3",
  "Description": "sample string 4",
  "CurrentStatus": 1,
  "SubProjectId": 1,
  "StoryPriority": 1,
  "StoryPoints": 1,
  "StoryEstimatedTime": 1,
  "CurrentOwnerId": 1,
  "TaskBoardFolderId": 1,
  "WorkObjective": 1,
  "PlanedStartDate": "2024-12-21 14:48:26",
  "PlanedEndDate": "2024-12-21 14:48:26",
  "StoryType": 1,
  "WorkType": 1,
  "ActualStoryPoints": 1
}

application/xml, text/xml

Sample: 
<StoryUpdateBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <ActualStoryPoints>1</ActualStoryPoints>
  <CurrentOwnerId>1</CurrentOwnerId>
  <CurrentStatus>1</CurrentStatus>
  <Description>sample string 4</Description>
  <PlanedEndDate>2024-12-21T18:48:26.1690545-08:00</PlanedEndDate>
  <PlanedStartDate>2024-12-21T18:48:26.1690545-08:00</PlanedStartDate>
  <StoryEstimatedTime>1</StoryEstimatedTime>
  <StoryPoints>1</StoryPoints>
  <StoryPriority>1</StoryPriority>
  <StoryTitle>sample string 3</StoryTitle>
  <StoryType>1</StoryType>
  <SubProjectId>1</SubProjectId>
  <TaskBoardFolderId>1</TaskBoardFolderId>
  <WorkObjective>1</WorkObjective>
  <WorkType>1</WorkType>
  <ProjectId>1</ProjectId>
  <StoryId>2</StoryId>
</StoryUpdateBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Update a story based on story item id.

ApiReturn
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  }
}

application/xml, text/xml

Sample: 
<ApiReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</ApiReturn>