POST api/Lists/GetItem

Request Information

URI Parameters

None.

Body Parameters

ListItemInfo
NameDescriptionTypeAdditional information
tkn

string

Required

String length: inclusive between 1 and 50

ListItemGUID

string

Required

String length: inclusive between 5 and 100

Request Formats

application/json, text/json

Sample:
{
  "tkn": "sample string 1",
  "ListItemGUID": "sample string 2"
}

application/octet-stream

Sample:
{"tkn":"sample string 1","ListItemGUID":"sample string 2"}

application/xml, text/xml

Sample:
<ListItemInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <tkn>sample string 1</tkn>
  <ListItemGUID>sample string 2</ListItemGUID>
</ListItemInfo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ListItemInfo'.

Response Information

Resource Description

ListsEntity
NameDescriptionTypeAdditional information
Name

string

None.

ListTypeGUID

string

None.

TagUID

string

None.

Value

string

None.

ExternalID

string

None.

Values

Collection of Field

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "ListTypeGUID": "sample string 2",
  "TagUID": "sample string 3",
  "Value": "sample string 4",
  "ExternalID": "sample string 5",
  "Values": [
    {
      "apiId": "sample string 1",
      "Value": {},
      "ExternalID": "sample string 3"
    },
    {
      "apiId": "sample string 1",
      "Value": {},
      "ExternalID": "sample string 3"
    }
  ]
}

application/octet-stream

Sample:
{"Name":"sample string 1","ListTypeGUID":"sample string 2","TagUID":"sample string 3","Value":"sample string 4","ExternalID":"sample string 5","Values":[{"apiId":"sample string 1","Value":{},"ExternalID":"sample string 3"},{"apiId":"sample string 1","Value":{},"ExternalID":"sample string 3"}]}

application/xml, text/xml

Sample:
<ListsEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <ListTypeGUID>sample string 2</ListTypeGUID>
  <TagUID>sample string 3</TagUID>
  <Value>sample string 4</Value>
  <ExternalID>sample string 5</ExternalID>
  <Values>
    <Field>
      <apiId>sample string 1</apiId>
      <Value />
      <ExternalID>sample string 3</ExternalID>
    </Field>
    <Field>
      <apiId>sample string 1</apiId>
      <Value />
      <ExternalID>sample string 3</ExternalID>
    </Field>
  </Values>
</ListsEntity>