GET api/lists/{id}

Gets the list with the specified id.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Returns a list.

WorkPoint365.WebAPI.Model.SharePoint.List

Name	Type	Additional information
ID	globally unique identifier	None.
Title	string	None.
ListTemplateId	string	None.
ServerRelativeUrl	string	None.
ListImageUrl	string	None.
Description	string	None.
BaseType	WorkPoint365.WebAPI.Model.SharePoint.ListBaseType	None.
ListDefinition	WorkPoint365.WebAPI.Model.SharePoint.ListDefinition	None.
IsApplicationList	boolean	None.
IsSiteAssetsLibrary	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "c25ee862-47ec-4819-82fc-99c3b1e80ee6",
  "Title": "sample string 2",
  "ListTemplateId": "sample string 3",
  "ServerRelativeUrl": "sample string 4",
  "ListImageUrl": "sample string 5",
  "Description": "sample string 6",
  "BaseType": 0,
  "ListDefinition": {
    "ID": "9cb618bc-e9ef-43e0-a638-778e9c4a9246",
    "Title": "sample string 2",
    "Fields": [
      {
        "ID": "38017274-8a95-4595-b466-2b0c1493400d",
        "Title": "sample string 2",
        "Type": "sample string 3",
        "DefaultValue": "sample string 4",
        "Description": "sample string 5",
        "InternalName": "sample string 6",
        "Required": true,
        "ShowInEditForm": true,
        "ShowInNewForm": true,
        "ShowInDisplayForm": true,
        "ShowInViewForms": true,
        "SchemaXml": "sample string 8"
      },
      {
        "ID": "38017274-8a95-4595-b466-2b0c1493400d",
        "Title": "sample string 2",
        "Type": "sample string 3",
        "DefaultValue": "sample string 4",
        "Description": "sample string 5",
        "InternalName": "sample string 6",
        "Required": true,
        "ShowInEditForm": true,
        "ShowInNewForm": true,
        "ShowInDisplayForm": true,
        "ShowInViewForms": true,
        "SchemaXml": "sample string 8"
      }
    ],
    "ContentTypes": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "Fields": [
          {
            "InternalFieldName": "sample string 1",
            "Required": true
          },
          {
            "InternalFieldName": "sample string 1",
            "Required": true
          }
        ]
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "Fields": [
          {
            "InternalFieldName": "sample string 1",
            "Required": true
          },
          {
            "InternalFieldName": "sample string 1",
            "Required": true
          }
        ]
      }
    ],
    "ViewDefinitions": [
      {
        "ID": "44e8c051-a06d-4a68-bdbc-e53ca2fda554",
        "Title": "sample string 2",
        "Type": "sample string 3",
        "DefaultView": true,
        "Paged": true,
        "Query": "sample string 6",
        "RowLimit": 7,
        "Fields": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "ID": "44e8c051-a06d-4a68-bdbc-e53ca2fda554",
        "Title": "sample string 2",
        "Type": "sample string 3",
        "DefaultView": true,
        "Paged": true,
        "Query": "sample string 6",
        "RowLimit": 7,
        "Fields": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  },
  "IsApplicationList": true,
  "IsSiteAssetsLibrary": true
}

application/xml, text/xml

Sample:

<List xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.SharePoint">
  <BaseType>UnspecifiedBaseType</BaseType>
  <Description>sample string 6</Description>
  <ID>c25ee862-47ec-4819-82fc-99c3b1e80ee6</ID>
  <IsApplicationList>true</IsApplicationList>
  <IsSiteAssetsLibrary>true</IsSiteAssetsLibrary>
  <ListDefinition>
    <ContentTypes>
      <ContentTypeDefinition>
        <Description>sample string 3</Description>
        <Fields>
          <FieldLink>
            <InternalFieldName>sample string 1</InternalFieldName>
            <Required>true</Required>
          </FieldLink>
          <FieldLink>
            <InternalFieldName>sample string 1</InternalFieldName>
            <Required>true</Required>
          </FieldLink>
        </Fields>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </ContentTypeDefinition>
      <ContentTypeDefinition>
        <Description>sample string 3</Description>
        <Fields>
          <FieldLink>
            <InternalFieldName>sample string 1</InternalFieldName>
            <Required>true</Required>
          </FieldLink>
          <FieldLink>
            <InternalFieldName>sample string 1</InternalFieldName>
            <Required>true</Required>
          </FieldLink>
        </Fields>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </ContentTypeDefinition>
    </ContentTypes>
    <Fields>
      <Field>
        <DefaultValue>sample string 4</DefaultValue>
        <Description>sample string 5</Description>
        <ID>38017274-8a95-4595-b466-2b0c1493400d</ID>
        <InternalName>sample string 6</InternalName>
        <Required>true</Required>
        <SchemaXml>sample string 8</SchemaXml>
        <ShowInDisplayForm>true</ShowInDisplayForm>
        <ShowInEditForm>true</ShowInEditForm>
        <ShowInNewForm>true</ShowInNewForm>
        <ShowInViewForms>true</ShowInViewForms>
        <Title>sample string 2</Title>
        <Type>sample string 3</Type>
      </Field>
      <Field>
        <DefaultValue>sample string 4</DefaultValue>
        <Description>sample string 5</Description>
        <ID>38017274-8a95-4595-b466-2b0c1493400d</ID>
        <InternalName>sample string 6</InternalName>
        <Required>true</Required>
        <SchemaXml>sample string 8</SchemaXml>
        <ShowInDisplayForm>true</ShowInDisplayForm>
        <ShowInEditForm>true</ShowInEditForm>
        <ShowInNewForm>true</ShowInNewForm>
        <ShowInViewForms>true</ShowInViewForms>
        <Title>sample string 2</Title>
        <Type>sample string 3</Type>
      </Field>
    </Fields>
    <ID>9cb618bc-e9ef-43e0-a638-778e9c4a9246</ID>
    <Title>sample string 2</Title>
    <ViewDefinitions>
      <ViewDefinition>
        <DefaultView>true</DefaultView>
        <Fields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Fields>
        <ID>44e8c051-a06d-4a68-bdbc-e53ca2fda554</ID>
        <Paged>true</Paged>
        <Query>sample string 6</Query>
        <RowLimit>7</RowLimit>
        <Title>sample string 2</Title>
        <Type>sample string 3</Type>
      </ViewDefinition>
      <ViewDefinition>
        <DefaultView>true</DefaultView>
        <Fields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Fields>
        <ID>44e8c051-a06d-4a68-bdbc-e53ca2fda554</ID>
        <Paged>true</Paged>
        <Query>sample string 6</Query>
        <RowLimit>7</RowLimit>
        <Title>sample string 2</Title>
        <Type>sample string 3</Type>
      </ViewDefinition>
    </ViewDefinitions>
  </ListDefinition>
  <ListImageUrl>sample string 5</ListImageUrl>
  <ListTemplateId>sample string 3</ListTemplateId>
  <ServerRelativeUrl>sample string 4</ServerRelativeUrl>
  <Title>sample string 2</Title>
</List>