Item.Body Field

When retrieving an Item, data that's specific to the kind of item is returned in the item's Body field, such as an actor's goals since they're only applicable to Actors. Each kind of item will return a different type of body object, as documented below.

If you are retrieving XML, the type of the body object will be indicated in an attribute, for example:


                <Body xsi:type="ActorBody">

                  <Goals>...</Goals>

                </Body>

ActorBody

application/json, text/json

Sample:

{
  "Goals": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ActorBody xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Goals>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Goals>
</ActorBody>

DefinitionBody

application/json, text/json

Sample:

{
  "Aliases": "sample string 1",
  "Fields": [
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Description": "sample string 3",
      "Constraints": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Description": "sample string 3",
      "Constraints": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<DefinitionBody xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Aliases>sample string 1</Aliases>
  <Fields>
    <Field>
      <Name>sample string 1</Name>
      <Type>sample string 2</Type>
      <Description>sample string 3</Description>
      <Constraints>sample string 4</Constraints>
    </Field>
    <Field>
      <Name>sample string 1</Name>
      <Type>sample string 2</Type>
      <Description>sample string 3</Description>
      <Constraints>sample string 4</Constraints>
    </Field>
  </Fields>
</DefinitionBody>

DiagramBody

application/json, text/json

Sample:

{
  "ImageUrl": "sample string 1"
}

application/xml, text/xml

Sample:

<DiagramBody xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ImageUrl>sample string 1</ImageUrl>
</DiagramBody>

RequirementBody

application/json, text/json

Sample:

{
  "ChildReqs": [
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    }
  ],
  "ReferencedReqs": [
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<RequirementBody xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ChildReqs>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
  </ChildReqs>
  <ReferencedReqs>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
  </ReferencedReqs>
</RequirementBody>

StoryBody

application/json, text/json

Sample:

{
  "ChildStories": [
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    }
  ],
  "AcceptanceCriteria": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<StoryBody xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ChildStories>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
  </ChildStories>
  <AcceptanceCriteria>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </AcceptanceCriteria>
</StoryBody>

UseCaseBody

application/json, text/json

Sample:

{
  "Prose": "sample string 1",
  "PreConditions": "sample string 2",
  "SuccessGuarantees": "sample string 3",
  "TestingSetup": "sample string 4",
  "TestingConfigurations": "sample string 5",
  "ChildUseCases": [
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    }
  ],
  "PrimaryActors": [
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    }
  ],
  "SupportingActors": [
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    }
  ],
  "ReferencedReqs": [
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    },
    {
      "ItemID": "sample string 1",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "Api": "sample string 4"
    }
  ],
  "Steps": [
    {
      "StepNumber": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "StepNumber": "sample string 1",
      "Description": "sample string 2"
    }
  ],
  "Extensions": [
    {
      "ExtensionNumber": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "ExtensionNumber": "sample string 1",
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<UseCaseBody xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Prose>sample string 1</Prose>
  <PreConditions>sample string 2</PreConditions>
  <SuccessGuarantees>sample string 3</SuccessGuarantees>
  <TestingSetup>sample string 4</TestingSetup>
  <TestingConfigurations>sample string 5</TestingConfigurations>
  <ChildUseCases>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
  </ChildUseCases>
  <PrimaryActors>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
  </PrimaryActors>
  <SupportingActors>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
  </SupportingActors>
  <ReferencedReqs>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
    <ItemRef>
      <ItemID>sample string 1</ItemID>
      <Name>sample string 2</Name>
      <Url>sample string 3</Url>
      <Api>sample string 4</Api>
    </ItemRef>
  </ReferencedReqs>
  <Steps>
    <Step>
      <StepNumber>sample string 1</StepNumber>
      <Description>sample string 2</Description>
    </Step>
    <Step>
      <StepNumber>sample string 1</StepNumber>
      <Description>sample string 2</Description>
    </Step>
  </Steps>
  <Extensions>
    <Extension>
      <ExtensionNumber>sample string 1</ExtensionNumber>
      <Description>sample string 2</Description>
    </Extension>
    <Extension>
      <ExtensionNumber>sample string 1</ExtensionNumber>
      <Description>sample string 2</Description>
    </Extension>
  </Extensions>
</UseCaseBody>