GET v1/item/{item_id}

Return the item with the given ID.

Request Information

Parameters

Name	Description	Additional information
item_id	The ID used by requirements.cc	Define this parameter in the request URI.

Response Information

A single item

Response body formats

application/json, text/json

Sample:

{
  "ID": 1,
  "ItemID": "sample string 2",
  "Url": "sample string 3",
  "Kind": "sample string 4",
  "Name": "sample string 5",
  "Description": "sample string 6",
  "Author": "sample string 7",
  "Changed": "2024-12-21T07:44:43.2725124+00:00",
  "Parent": {
    "ItemID": "sample string 1",
    "Name": "sample string 2",
    "Url": "sample string 3",
    "Api": "sample string 4"
  },
  "Issues": [
    {
      "Description": "sample string 1",
      "Type": "sample string 2",
      "Status": "sample string 3",
      "AppliesTo": "sample string 4",
      "AssignedTo": "sample string 5",
      "Priority": "sample string 6",
      "Risk": "sample string 7",
      "Complexity": "sample string 8",
      "ResolveBy": "sample string 9",
      "Resolution": "sample string 10",
      "DateResolved": "sample string 11",
      "ExternalReference": "sample string 12"
    },
    {
      "Description": "sample string 1",
      "Type": "sample string 2",
      "Status": "sample string 3",
      "AppliesTo": "sample string 4",
      "AssignedTo": "sample string 5",
      "Priority": "sample string 6",
      "Risk": "sample string 7",
      "Complexity": "sample string 8",
      "ResolveBy": "sample string 9",
      "Resolution": "sample string 10",
      "DateResolved": "sample string 11",
      "ExternalReference": "sample string 12"
    }
  ],
  "Notes": [
    {
      "Description": "sample string 1",
      "DateAdded": "sample string 2"
    },
    {
      "Description": "sample string 1",
      "DateAdded": "sample string 2"
    }
  ],
  "Diagrams": [
    {
      "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"
    }
  ],
  "CustomFields": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Comments": [
    {
      "ID": 1,
      "Author": "sample string 2",
      "Created": "2024-12-21T07:44:43.2725124+00:00",
      "Text": "sample string 4"
    },
    {
      "ID": 1,
      "Author": "sample string 2",
      "Created": "2024-12-21T07:44:43.2725124+00:00",
      "Text": "sample string 4"
    }
  ],
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "Body": {},
  "BodyAsText": "sample string 10"
}

application/xml, text/xml

Sample:

<Item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID>1</ID>
  <ItemID>sample string 2</ItemID>
  <Url>sample string 3</Url>
  <Kind>sample string 4</Kind>
  <Name>sample string 5</Name>
  <Description>sample string 6</Description>
  <Author>sample string 7</Author>
  <Changed>2024-12-21T07:44:43.2725124+00:00</Changed>
  <Parent>
    <ItemID>sample string 1</ItemID>
    <Name>sample string 2</Name>
    <Url>sample string 3</Url>
    <Api>sample string 4</Api>
  </Parent>
  <Issues>
    <ItemIssue>
      <Description>sample string 1</Description>
      <Type>sample string 2</Type>
      <Status>sample string 3</Status>
      <AppliesTo>sample string 4</AppliesTo>
      <AssignedTo>sample string 5</AssignedTo>
      <Priority>sample string 6</Priority>
      <Risk>sample string 7</Risk>
      <Complexity>sample string 8</Complexity>
      <ResolveBy>sample string 9</ResolveBy>
      <Resolution>sample string 10</Resolution>
      <DateResolved>sample string 11</DateResolved>
      <ExternalReference>sample string 12</ExternalReference>
    </ItemIssue>
    <ItemIssue>
      <Description>sample string 1</Description>
      <Type>sample string 2</Type>
      <Status>sample string 3</Status>
      <AppliesTo>sample string 4</AppliesTo>
      <AssignedTo>sample string 5</AssignedTo>
      <Priority>sample string 6</Priority>
      <Risk>sample string 7</Risk>
      <Complexity>sample string 8</Complexity>
      <ResolveBy>sample string 9</ResolveBy>
      <Resolution>sample string 10</Resolution>
      <DateResolved>sample string 11</DateResolved>
      <ExternalReference>sample string 12</ExternalReference>
    </ItemIssue>
  </Issues>
  <Notes>
    <Note>
      <Description>sample string 1</Description>
      <DateAdded>sample string 2</DateAdded>
    </Note>
    <Note>
      <Description>sample string 1</Description>
      <DateAdded>sample string 2</DateAdded>
    </Note>
  </Notes>
  <Diagrams>
    <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>
  </Diagrams>
  <CustomFields>
    <CustomField>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </CustomField>
    <CustomField>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </CustomField>
  </CustomFields>
  <Comments>
    <ItemComment>
      <ID>1</ID>
      <Author>sample string 2</Author>
      <Created>2024-12-21T07:44:43.2725124+00:00</Created>
      <Text>sample string 4</Text>
    </ItemComment>
    <ItemComment>
      <ID>1</ID>
      <Author>sample string 2</Author>
      <Created>2024-12-21T07:44:43.2725124+00:00</Created>
      <Text>sample string 4</Text>
    </ItemComment>
  </Comments>
  <Tags>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Tags>
  <Body />
  <BodyAsText>sample string 10</BodyAsText>
</Item>