POST api/Story/ListBySpec

List stories based on a spec item

Request Information

URI Parameters

None.

Body Parameters

StoryListBySpecBinder
NameDescriptionTypeAdditional information
SpecProjectId

integer

None.

SpecItemId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SpecProjectId": 1,
  "SpecItemId": 2
}

application/xml, text/xml

Sample:
<StoryListBySpecBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <SpecItemId>2</SpecItemId>
  <SpecProjectId>1</SpecProjectId>
</StoryListBySpecBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List stories based on a spec item

API_Data_IEnumerableOfStoryAssignment
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

Collection of StoryAssignment

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": [
    {
      "ProjectId": 1,
      "StoryItemId": 2,
      "LinkedTasks": [
        {
          "IssueId": 1,
          "Title": "sample string 2",
          "SubProjectId": 3,
          "SubProjectPath": "sample string 4",
          "CurrentOwnerId": 5,
          "CurrentOwnerName": "sample string 6",
          "PlanedEndDate": "2020-12-04",
          "ImplementationModuleId": 7,
          "ImplementationModuleName": "sample string 8",
          "TaskPoints": 9,
          "TimeSpent": "0.2h",
          "TimeRemain": "0.2h",
          "FinishPercentage": 47
        },
        {
          "IssueId": 1,
          "Title": "sample string 2",
          "SubProjectId": 3,
          "SubProjectPath": "sample string 4",
          "CurrentOwnerId": 5,
          "CurrentOwnerName": "sample string 6",
          "PlanedEndDate": "2020-12-04",
          "ImplementationModuleId": 7,
          "ImplementationModuleName": "sample string 8",
          "TaskPoints": 9,
          "TimeSpent": "0.2h",
          "TimeRemain": "0.2h",
          "FinishPercentage": 47
        }
      ],
      "DisplayId": "sample string 3",
      "ParentSubProjectId": 4,
      "ParentSubProjectPath": "sample string 5",
      "ImplementionCopyNo": 6,
      "LinkedSpecItemId": 7,
      "LinkedSpecProjectId": 8,
      "StoryTitle": "sample string 9",
      "StoryType": 10,
      "StoryPriority": 1,
      "StoryPoints": 1,
      "CurrentOwnerId": 1,
      "CurrentOwnerName": "sample string 11",
      "IfCreatedFromSpec": true,
      "IfInBacklogFolder": true,
      "IfStandaloneStory": true,
      "TimeSpent": "0.3h",
      "TimeRemain": "0.4h",
      "FinishPercentage": 47
    },
    {
      "ProjectId": 1,
      "StoryItemId": 2,
      "LinkedTasks": [
        {
          "IssueId": 1,
          "Title": "sample string 2",
          "SubProjectId": 3,
          "SubProjectPath": "sample string 4",
          "CurrentOwnerId": 5,
          "CurrentOwnerName": "sample string 6",
          "PlanedEndDate": "2020-12-04",
          "ImplementationModuleId": 7,
          "ImplementationModuleName": "sample string 8",
          "TaskPoints": 9,
          "TimeSpent": "0.2h",
          "TimeRemain": "0.2h",
          "FinishPercentage": 47
        },
        {
          "IssueId": 1,
          "Title": "sample string 2",
          "SubProjectId": 3,
          "SubProjectPath": "sample string 4",
          "CurrentOwnerId": 5,
          "CurrentOwnerName": "sample string 6",
          "PlanedEndDate": "2020-12-04",
          "ImplementationModuleId": 7,
          "ImplementationModuleName": "sample string 8",
          "TaskPoints": 9,
          "TimeSpent": "0.2h",
          "TimeRemain": "0.2h",
          "FinishPercentage": 47
        }
      ],
      "DisplayId": "sample string 3",
      "ParentSubProjectId": 4,
      "ParentSubProjectPath": "sample string 5",
      "ImplementionCopyNo": 6,
      "LinkedSpecItemId": 7,
      "LinkedSpecProjectId": 8,
      "StoryTitle": "sample string 9",
      "StoryType": 10,
      "StoryPriority": 1,
      "StoryPoints": 1,
      "CurrentOwnerId": 1,
      "CurrentOwnerName": "sample string 11",
      "IfCreatedFromSpec": true,
      "IfInBacklogFolder": true,
      "IfStandaloneStory": true,
      "TimeSpent": "0.3h",
      "TimeRemain": "0.4h",
      "FinishPercentage": 47
    }
  ]
}

application/xml, text/xml

Sample:
<API_Data_ArrayOfStoryAssignment 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.Entities">
    <d2p1:StoryAssignment>
      <d2p1:CurrentOwnerId>1</d2p1:CurrentOwnerId>
      <d2p1:CurrentOwnerName>sample string 11</d2p1:CurrentOwnerName>
      <d2p1:DisplayId>sample string 3</d2p1:DisplayId>
      <d2p1:IfCreatedFromSpec>true</d2p1:IfCreatedFromSpec>
      <d2p1:IfInBacklogFolder>true</d2p1:IfInBacklogFolder>
      <d2p1:IfStandaloneStory>true</d2p1:IfStandaloneStory>
      <d2p1:ImplementionCopyNo>6</d2p1:ImplementionCopyNo>
      <d2p1:LinkedSpecItemId>7</d2p1:LinkedSpecItemId>
      <d2p1:LinkedSpecProjectId>8</d2p1:LinkedSpecProjectId>
      <d2p1:LinkedTasks>
        <d2p1:LinkedTask>
          <d2p1:CurrentOwnerId>5</d2p1:CurrentOwnerId>
          <d2p1:CurrentOwnerName>sample string 6</d2p1:CurrentOwnerName>
          <d2p1:ImplementationModuleId>7</d2p1:ImplementationModuleId>
          <d2p1:ImplementationModuleName>sample string 8</d2p1:ImplementationModuleName>
          <d2p1:IssueId>1</d2p1:IssueId>
          <d2p1:PlanedEndDate>2020-12-04T09:53:48.1970444-08:00</d2p1:PlanedEndDate>
          <d2p1:SubProjectId>3</d2p1:SubProjectId>
          <d2p1:SubProjectPath>sample string 4</d2p1:SubProjectPath>
          <d2p1:TaskPoints>9</d2p1:TaskPoints>
          <d2p1:Title>sample string 2</d2p1:Title>
        </d2p1:LinkedTask>
        <d2p1:LinkedTask>
          <d2p1:CurrentOwnerId>5</d2p1:CurrentOwnerId>
          <d2p1:CurrentOwnerName>sample string 6</d2p1:CurrentOwnerName>
          <d2p1:ImplementationModuleId>7</d2p1:ImplementationModuleId>
          <d2p1:ImplementationModuleName>sample string 8</d2p1:ImplementationModuleName>
          <d2p1:IssueId>1</d2p1:IssueId>
          <d2p1:PlanedEndDate>2020-12-04T09:53:48.1970444-08:00</d2p1:PlanedEndDate>
          <d2p1:SubProjectId>3</d2p1:SubProjectId>
          <d2p1:SubProjectPath>sample string 4</d2p1:SubProjectPath>
          <d2p1:TaskPoints>9</d2p1:TaskPoints>
          <d2p1:Title>sample string 2</d2p1:Title>
        </d2p1:LinkedTask>
      </d2p1:LinkedTasks>
      <d2p1:ParentSubProjectId>4</d2p1:ParentSubProjectId>
      <d2p1:ParentSubProjectPath>sample string 5</d2p1:ParentSubProjectPath>
      <d2p1:ProjectId>1</d2p1:ProjectId>
      <d2p1:StoryItemId>2</d2p1:StoryItemId>
      <d2p1:StoryPoints>1</d2p1:StoryPoints>
      <d2p1:StoryPriority>1</d2p1:StoryPriority>
      <d2p1:StoryTitle>sample string 9</d2p1:StoryTitle>
      <d2p1:StoryType>10</d2p1:StoryType>
    </d2p1:StoryAssignment>
    <d2p1:StoryAssignment>
      <d2p1:CurrentOwnerId>1</d2p1:CurrentOwnerId>
      <d2p1:CurrentOwnerName>sample string 11</d2p1:CurrentOwnerName>
      <d2p1:DisplayId>sample string 3</d2p1:DisplayId>
      <d2p1:IfCreatedFromSpec>true</d2p1:IfCreatedFromSpec>
      <d2p1:IfInBacklogFolder>true</d2p1:IfInBacklogFolder>
      <d2p1:IfStandaloneStory>true</d2p1:IfStandaloneStory>
      <d2p1:ImplementionCopyNo>6</d2p1:ImplementionCopyNo>
      <d2p1:LinkedSpecItemId>7</d2p1:LinkedSpecItemId>
      <d2p1:LinkedSpecProjectId>8</d2p1:LinkedSpecProjectId>
      <d2p1:LinkedTasks>
        <d2p1:LinkedTask>
          <d2p1:CurrentOwnerId>5</d2p1:CurrentOwnerId>
          <d2p1:CurrentOwnerName>sample string 6</d2p1:CurrentOwnerName>
          <d2p1:ImplementationModuleId>7</d2p1:ImplementationModuleId>
          <d2p1:ImplementationModuleName>sample string 8</d2p1:ImplementationModuleName>
          <d2p1:IssueId>1</d2p1:IssueId>
          <d2p1:PlanedEndDate>2020-12-04T09:53:48.1970444-08:00</d2p1:PlanedEndDate>
          <d2p1:SubProjectId>3</d2p1:SubProjectId>
          <d2p1:SubProjectPath>sample string 4</d2p1:SubProjectPath>
          <d2p1:TaskPoints>9</d2p1:TaskPoints>
          <d2p1:Title>sample string 2</d2p1:Title>
        </d2p1:LinkedTask>
        <d2p1:LinkedTask>
          <d2p1:CurrentOwnerId>5</d2p1:CurrentOwnerId>
          <d2p1:CurrentOwnerName>sample string 6</d2p1:CurrentOwnerName>
          <d2p1:ImplementationModuleId>7</d2p1:ImplementationModuleId>
          <d2p1:ImplementationModuleName>sample string 8</d2p1:ImplementationModuleName>
          <d2p1:IssueId>1</d2p1:IssueId>
          <d2p1:PlanedEndDate>2020-12-04T09:53:48.1970444-08:00</d2p1:PlanedEndDate>
          <d2p1:SubProjectId>3</d2p1:SubProjectId>
          <d2p1:SubProjectPath>sample string 4</d2p1:SubProjectPath>
          <d2p1:TaskPoints>9</d2p1:TaskPoints>
          <d2p1:Title>sample string 2</d2p1:Title>
        </d2p1:LinkedTask>
      </d2p1:LinkedTasks>
      <d2p1:ParentSubProjectId>4</d2p1:ParentSubProjectId>
      <d2p1:ParentSubProjectPath>sample string 5</d2p1:ParentSubProjectPath>
      <d2p1:ProjectId>1</d2p1:ProjectId>
      <d2p1:StoryItemId>2</d2p1:StoryItemId>
      <d2p1:StoryPoints>1</d2p1:StoryPoints>
      <d2p1:StoryPriority>1</d2p1:StoryPriority>
      <d2p1:StoryTitle>sample string 9</d2p1:StoryTitle>
      <d2p1:StoryType>10</d2p1:StoryType>
    </d2p1:StoryAssignment>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfStoryAssignment>