GET api/BusinessModules/{id}/SubStages?subStagesTermSetId={subStagesTermSetId}&stageId={stageId}

Gets the Substages for a given Stage on the Business Module with the specified id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the Business Module

globally unique identifier

Required

subStagesTermSetId

The id of the Term Set in TermStore to retrive Substages from

globally unique identifier

Required

stageId

The id of a Stage in the Stage Model

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of Substages for the given Stage.

Collection of WorkPoint.Core.Models.Stages.SubStage
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

TermId

string

None.

Title

string

None.

TitleResources

Collection of WorkPoint.Core.Models.Stages.SupportLanguagesViewModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "2f0c1c35-2b8a-4bc5-b8b0-11246949ee6b",
    "TermId": "sample string 2",
    "Title": "sample string 3",
    "TitleResources": [
      {
        "ResourceName": "sample string 1",
        "ResourceValue": "sample string 2"
      },
      {
        "ResourceName": "sample string 1",
        "ResourceValue": "sample string 2"
      }
    ]
  },
  {
    "Id": "2f0c1c35-2b8a-4bc5-b8b0-11246949ee6b",
    "TermId": "sample string 2",
    "Title": "sample string 3",
    "TitleResources": [
      {
        "ResourceName": "sample string 1",
        "ResourceValue": "sample string 2"
      },
      {
        "ResourceName": "sample string 1",
        "ResourceValue": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfSubStage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.Stages">
  <SubStage>
    <Id>2f0c1c35-2b8a-4bc5-b8b0-11246949ee6b</Id>
    <TermId>sample string 2</TermId>
    <Title>sample string 3</Title>
    <TitleResources>
      <SupportLanguagesViewModel>
        <ResourceName>sample string 1</ResourceName>
        <ResourceValue>sample string 2</ResourceValue>
      </SupportLanguagesViewModel>
      <SupportLanguagesViewModel>
        <ResourceName>sample string 1</ResourceName>
        <ResourceValue>sample string 2</ResourceValue>
      </SupportLanguagesViewModel>
    </TitleResources>
  </SubStage>
  <SubStage>
    <Id>2f0c1c35-2b8a-4bc5-b8b0-11246949ee6b</Id>
    <TermId>sample string 2</TermId>
    <Title>sample string 3</Title>
    <TitleResources>
      <SupportLanguagesViewModel>
        <ResourceName>sample string 1</ResourceName>
        <ResourceValue>sample string 2</ResourceValue>
      </SupportLanguagesViewModel>
      <SupportLanguagesViewModel>
        <ResourceName>sample string 1</ResourceName>
        <ResourceValue>sample string 2</ResourceValue>
      </SupportLanguagesViewModel>
    </TitleResources>
  </SubStage>
</ArrayOfSubStage>