GET api/List/{listId}/Item/{id}?includeFile={includeFile}
Gets the item with the specified id, on the given listId
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
listId |
The id of the list |
string |
Required |
id |
The id of the list item |
integer |
Required |
includeFile |
An optional parameter. A boolean indicating if the file for the given list item should be returned in the result. By default the file will not be included. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Returns a list item.
WorkPoint365.WebAPI.Model.SharePoint.ListItemName | Description | Type | Additional information |
---|---|---|---|
ContentType |
Gets or sets the type of the content. |
string |
None. |
ContentTypeId |
Gets or sets the content type identifier. |
string |
None. |
ID |
Gets or sets the identifier. |
integer |
None. |
UniqueId |
Gets or sets the unique identifier. |
globally unique identifier |
None. |
Title |
Gets or sets the title. |
string |
None. |
IsEntity |
Gets or sets a value indicating whether this instance is entity. |
boolean |
None. |
Site |
Gets or sets the site. |
string |
None. |
Url |
Gets or sets the URL. |
string |
None. |
FieldValues |
Gets or sets the field values. |
Collection of WorkPoint365.WebAPI.Model.SharePoint.ListItem+FieldValue |
None. |
ParentList |
Gets or sets the parent list. |
string |
None. |
ParentListId |
Gets or sets the parent list identifier. |
globally unique identifier |
None. |
Icons |
Gets or sets the icons. |
WorkPoint365.WebAPI.Model.SharePoint.ListItem+ItemIcon |
None. |
FileInfo |
Gets or sets the file information. |
WorkPoint365.WebAPI.Model.SharePoint.ListItem+File |
None. |
Response Formats
application/json, text/json
{ "ContentType": "sample string 1", "ContentTypeId": "sample string 2", "ID": 3, "UniqueId": "7d2fe06d-2498-4d02-8687-cce69ebf04c3", "Title": "sample string 5", "IsEntity": true, "Site": "sample string 7", "Url": "sample string 8", "FieldValues": [ { "InternalFieldName": "sample string 1", "DisplayFieldName": "sample string 2", "Value": "sample string 3", "TextValue": "sample string 4" }, { "InternalFieldName": "sample string 1", "DisplayFieldName": "sample string 2", "Value": "sample string 3", "TextValue": "sample string 4" } ], "ParentList": "sample string 9", "ParentListId": "27d5d845-82d2-47dc-99b5-e451ea0b359b", "Icons": { "Color16": "sample string 1", "Color32": "sample string 2", "White16": "sample string 3", "White32": "sample string 4", "Grey16": "sample string 5", "Grey32": "sample string 6" }, "FileInfo": { "Id": 1, "UniqueId": "193ef8aa-6fb1-4ea5-afa7-c3dc5f0ed558", "FileBytes": "sample string 3", "FileName": "sample string 4", "Length": 5 } }
application/xml, text/xml
<ListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.SharePoint"> <ContentType>sample string 1</ContentType> <ContentTypeId>sample string 2</ContentTypeId> <FieldValues> <ListItem.FieldValue> <DisplayFieldName>sample string 2</DisplayFieldName> <InternalFieldName>sample string 1</InternalFieldName> <TextValue>sample string 4</TextValue> <Value>sample string 3</Value> </ListItem.FieldValue> <ListItem.FieldValue> <DisplayFieldName>sample string 2</DisplayFieldName> <InternalFieldName>sample string 1</InternalFieldName> <TextValue>sample string 4</TextValue> <Value>sample string 3</Value> </ListItem.FieldValue> </FieldValues> <FileInfo> <FileBytes>sample string 3</FileBytes> <FileName>sample string 4</FileName> <Id>1</Id> <Length>5</Length> <UniqueId>193ef8aa-6fb1-4ea5-afa7-c3dc5f0ed558</UniqueId> </FileInfo> <ID>3</ID> <Icons> <Color16>sample string 1</Color16> <Color32>sample string 2</Color32> <Grey16>sample string 5</Grey16> <Grey32>sample string 6</Grey32> <White16>sample string 3</White16> <White32>sample string 4</White32> </Icons> <IsEntity>true</IsEntity> <ParentList>sample string 9</ParentList> <ParentListId>27d5d845-82d2-47dc-99b5-e451ea0b359b</ParentListId> <Site>sample string 7</Site> <Title>sample string 5</Title> <UniqueId>7d2fe06d-2498-4d02-8687-cce69ebf04c3</UniqueId> <Url>sample string 8</Url> </ListItem>