POST api/List/{listId}/Items

Gets all the items on the specified listId

Request Information

URI Parameters

Name	Description	Type	Additional information
listId	The id of the list	string	Required

Body Parameters

A query object used to query the list for items

WorkPoint365.WebAPI.Model.ListQueryParameter

Name	Description	Type	Additional information
CamlQuery	Gets or sets the caml query.	string	None.
FilterActiveItems	Gets or sets a value indicating whether [filter active items].	boolean	None.
FilterMyItems	Gets or sets a value indicating whether [filter my items].	boolean	None.
PageSize	Gets or sets the size of the page.	unsigned integer	None.
PagingInfo	Gets or sets the paging information.	string	None.
ViewFields	Gets or sets the view fields.	Collection of string	None.
FolderServerRelativeUrl	Gets or sets the folder server relative URL.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CamlQuery": "sample string 1",
  "FilterActiveItems": true,
  "FilterMyItems": true,
  "PageSize": 4,
  "PagingInfo": "sample string 5",
  "ViewFields": [
    "sample string 1",
    "sample string 2"
  ],
  "FolderServerRelativeUrl": "sample string 6"
}

application/xml, text/xml

Sample:

<ListQueryParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <CamlQuery>sample string 1</CamlQuery>
  <FilterActiveItems>true</FilterActiveItems>
  <FilterMyItems>true</FilterMyItems>
  <FolderServerRelativeUrl>sample string 6</FolderServerRelativeUrl>
  <PageSize>4</PageSize>
  <PagingInfo>sample string 5</PagingInfo>
  <ViewFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ViewFields>
</ListQueryParameter>

Response Information

Resource Description

Returns a QueryResult with a collection of items

WorkPoint365.WebAPI.Model.QueryResult

Name	Description	Type	Additional information
Items	Gets or sets the items.	Collection of WorkPoint365.WebAPI.Model.SharePoint.ListItem	None.
PagingInfo	Gets or sets the paging information.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "ContentType": "sample string 1",
      "ContentTypeId": "sample string 2",
      "ID": 3,
      "UniqueId": "022568ac-a063-4f0b-bbf6-684317dffc15",
      "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": "e336ecca-8412-4a23-85b3-6ed679f6240b",
      "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": "efc136c7-fb0d-4837-b6ee-e0458cc7f29e",
        "FileBytes": "sample string 3",
        "FileName": "sample string 4",
        "Length": 5
      }
    },
    {
      "ContentType": "sample string 1",
      "ContentTypeId": "sample string 2",
      "ID": 3,
      "UniqueId": "022568ac-a063-4f0b-bbf6-684317dffc15",
      "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": "e336ecca-8412-4a23-85b3-6ed679f6240b",
      "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": "efc136c7-fb0d-4837-b6ee-e0458cc7f29e",
        "FileBytes": "sample string 3",
        "FileName": "sample string 4",
        "Length": 5
      }
    }
  ],
  "PagingInfo": "sample string 1"
}

application/xml, text/xml

Sample:

<QueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.SharePoint">
    <d2p1:ListItem>
      <d2p1:ContentType>sample string 1</d2p1:ContentType>
      <d2p1:ContentTypeId>sample string 2</d2p1:ContentTypeId>
      <d2p1:FieldValues>
        <d2p1:ListItem.FieldValue>
          <d2p1:DisplayFieldName>sample string 2</d2p1:DisplayFieldName>
          <d2p1:InternalFieldName>sample string 1</d2p1:InternalFieldName>
          <d2p1:TextValue>sample string 4</d2p1:TextValue>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:ListItem.FieldValue>
        <d2p1:ListItem.FieldValue>
          <d2p1:DisplayFieldName>sample string 2</d2p1:DisplayFieldName>
          <d2p1:InternalFieldName>sample string 1</d2p1:InternalFieldName>
          <d2p1:TextValue>sample string 4</d2p1:TextValue>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:ListItem.FieldValue>
      </d2p1:FieldValues>
      <d2p1:FileInfo>
        <d2p1:FileBytes>sample string 3</d2p1:FileBytes>
        <d2p1:FileName>sample string 4</d2p1:FileName>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Length>5</d2p1:Length>
        <d2p1:UniqueId>efc136c7-fb0d-4837-b6ee-e0458cc7f29e</d2p1:UniqueId>
      </d2p1:FileInfo>
      <d2p1:ID>3</d2p1:ID>
      <d2p1:Icons>
        <d2p1:Color16>sample string 1</d2p1:Color16>
        <d2p1:Color32>sample string 2</d2p1:Color32>
        <d2p1:Grey16>sample string 5</d2p1:Grey16>
        <d2p1:Grey32>sample string 6</d2p1:Grey32>
        <d2p1:White16>sample string 3</d2p1:White16>
        <d2p1:White32>sample string 4</d2p1:White32>
      </d2p1:Icons>
      <d2p1:IsEntity>true</d2p1:IsEntity>
      <d2p1:ParentList>sample string 9</d2p1:ParentList>
      <d2p1:ParentListId>e336ecca-8412-4a23-85b3-6ed679f6240b</d2p1:ParentListId>
      <d2p1:Site>sample string 7</d2p1:Site>
      <d2p1:Title>sample string 5</d2p1:Title>
      <d2p1:UniqueId>022568ac-a063-4f0b-bbf6-684317dffc15</d2p1:UniqueId>
      <d2p1:Url>sample string 8</d2p1:Url>
    </d2p1:ListItem>
    <d2p1:ListItem>
      <d2p1:ContentType>sample string 1</d2p1:ContentType>
      <d2p1:ContentTypeId>sample string 2</d2p1:ContentTypeId>
      <d2p1:FieldValues>
        <d2p1:ListItem.FieldValue>
          <d2p1:DisplayFieldName>sample string 2</d2p1:DisplayFieldName>
          <d2p1:InternalFieldName>sample string 1</d2p1:InternalFieldName>
          <d2p1:TextValue>sample string 4</d2p1:TextValue>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:ListItem.FieldValue>
        <d2p1:ListItem.FieldValue>
          <d2p1:DisplayFieldName>sample string 2</d2p1:DisplayFieldName>
          <d2p1:InternalFieldName>sample string 1</d2p1:InternalFieldName>
          <d2p1:TextValue>sample string 4</d2p1:TextValue>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:ListItem.FieldValue>
      </d2p1:FieldValues>
      <d2p1:FileInfo>
        <d2p1:FileBytes>sample string 3</d2p1:FileBytes>
        <d2p1:FileName>sample string 4</d2p1:FileName>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Length>5</d2p1:Length>
        <d2p1:UniqueId>efc136c7-fb0d-4837-b6ee-e0458cc7f29e</d2p1:UniqueId>
      </d2p1:FileInfo>
      <d2p1:ID>3</d2p1:ID>
      <d2p1:Icons>
        <d2p1:Color16>sample string 1</d2p1:Color16>
        <d2p1:Color32>sample string 2</d2p1:Color32>
        <d2p1:Grey16>sample string 5</d2p1:Grey16>
        <d2p1:Grey32>sample string 6</d2p1:Grey32>
        <d2p1:White16>sample string 3</d2p1:White16>
        <d2p1:White32>sample string 4</d2p1:White32>
      </d2p1:Icons>
      <d2p1:IsEntity>true</d2p1:IsEntity>
      <d2p1:ParentList>sample string 9</d2p1:ParentList>
      <d2p1:ParentListId>e336ecca-8412-4a23-85b3-6ed679f6240b</d2p1:ParentListId>
      <d2p1:Site>sample string 7</d2p1:Site>
      <d2p1:Title>sample string 5</d2p1:Title>
      <d2p1:UniqueId>022568ac-a063-4f0b-bbf6-684317dffc15</d2p1:UniqueId>
      <d2p1:Url>sample string 8</d2p1:Url>
    </d2p1:ListItem>
  </Items>
  <PagingInfo>sample string 1</PagingInfo>
</QueryResult>