Referência da API REST de listas e itens de lista
Saiba mais sobre listas, itens de lista, modos de exibição e outros recursos relacionados a lista, bem como pontos de extremidade da API REST.
Última alteração: quinta-feira, 17 de setembro de 2015
Aplica-se a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013
Sobre os exemplos de solicitação neste artigo
Os exemplos de solicitação neste artigo presumem que você esteja usando a biblioteca de domínio cruzado (SP RequestExecutor.js) para fazer solicitações entre domínios e, portanto, elas usem SP.AppContextSite no URI do ponto de extremidade. Veja Acessar dados do SharePoint 2013 de suplementos usando a biblioteca de domínio cruzado para obter mais informações.
Antes de usar um exemplo de solicitação, faça o seguinte:
Altere <app web url>, <host web url> e outros dados de espaço reservado, tais como quaisquer IDs, nomes ou caminhos de entidades do SharePoint.
Se você não estiver usando a biblioteca de domínio cruzado, inclua um cabeçalho X-RequestDigest para enviar o valor de resumo do formulário em todas as solicitações POST e um cabeçalho content-length para solicitações POST que enviam dados no corpo da solicitação.
Se você não estiver fazendo solicitações de domínio cruzado, remova SP.AppContextSite(@target) e ?@target='<host web url>' do URI do ponto de extremidade.
Se você estiver usando o OAuth, inclua um cabeçalho Authorization ("Authorization": "Bearer " + <access token>) para enviar o token de acesso OAuth.
Remova as quebras de linha dos valores de propriedade url e body nos exemplos de solicitação. Quebras de linha são adicionadas aos exemplos para facilitar a leitura.
Se quiser que o servidor retorne respostas no formato Atom, remova o cabeçalho "accept": "application/json; odata=verbose".
Veja Recursos adicionais para obter links que levam a mais informações sobre como usar a biblioteca de domínio cruzado, o OAuth e o serviço REST do SharePoint. Veja Como as solicitações REST diferem por ambiente e Propriedades usadas em solicitações REST para obter informações sobre os formatos de solicitação.
Dica
O serviço REST SharePoint Online dá suporte para a combinação de várias solicitações em uma única chamada do serviço, usando a opção de consulta OData $batch. Para obter detalhes e links para exemplos de códigos, confira Fazem solicitações de lote com as APIs REST. Ainda não há suporte para essa opção no SharePoint local.
Explore a sintaxe REST de listas e itens de lista do SharePoint 2013
|
Explore visualmente a sintaxe REST de listas e itens de lista do SharePoint 2013. Explore outros diagramas de sintaxe REST do SharePoint: Arquivos e pastas | Usuários e grupos Baixe o PDF combinado de todos os diagramas da sintaxe REST do SharePoint. |
.png "Explorar a lista de serviços e a sintaxe de itens de lista do REST")
Observação
A opção de consulta OData $skip não funciona quando itens de uma lista específica são consultados. Ela funciona quando o ponto de extremidade das listas é consultado.
Recurso List
Representa uma lista do SharePoint. Uma lista é um tipo de SP.SecurableObject.
URI do ponto de extremidade | Propriedades | Métodos | Representação do OData
URI do ponto de extremidade
http://<site url>/web/lists(guid'<list id>')
Métodos HTTP com suporte
GET | POST | DELETE | MERGE | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obter uma lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode usar o método GetByTitle do recurso ListCollection para obter uma lista pelo título. Exemplo: …/web/lists/getbytitle('Access Requests').
Exemplo de solicitação POST: Criar uma lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
headers: { "content-type": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
Exemplo de solicitação MERGE: Alterar uma lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
headers: {
"IF-MATCH": "*",
"X-HTTP-Method": "MERGE",
"content-type": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
Exemplo de solicitação DELETE: Excluir uma lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
?@target='<host web url>'",
method: "POST",
headers: {
"IF-MATCH": "*",
"X-HTTP-Method": "DELETE"
},
success: successHandler,
error: errorHandler
});
Se você quiser reciclar uma lista e obter o GUID do item de lixeira, use o método Recycle da lista para remover o arquivo.
Listar propriedades
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade da propriedade, conforme mostrado no exemplo a seguir.
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/<property name>
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Propriedade |
Tipo |
De leitura/gravação |
Descrição |
|
|---|---|---|---|---|
AllowContentTypes |
Boolean |
L |
Sim |
Obtém um valor que especifica se a lista oferece suporte a tipos de conteúdo. |
BaseTemplate |
Int32 |
L |
Sim |
Obtém o tipo de definição de lista no qual a lista se baseia. Representa um valor ListTemplateType. Veja ListTemplateType na referência de modelo de objeto do cliente do .NET para obter valores de tipo de modelo. |
BaseType |
Int32 |
L |
Sim |
Obtém o tipo base para a lista. Representa um valor SP.BaseType: Lista genérica = 0; Biblioteca de Documentos = 1; Quadro de Discussão = 3; Pesquisa = 4; Problema = 5. |
BrowserFileHandling |
Int32 |
L |
Não |
Obtém um valor que especifica a substituição da propriedade do aplicativo web BrowserFileHandling ao nível de lista. Representa um valor SP.BrowserFileHandling: Permissivo = 0; Estrito = 1. |
ContentTypes |
SP.ContentTypeCollection |
L |
Não |
Obtém os tipos de conteúdo que estão associados à lista. |
ContentTypesEnabled |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se tipos de conteúdo estão habilitados para a lista. |
Created |
DateTime |
L |
Sim |
Obtém um valor que especifica quando a lista foi criada. |
DataSource |
L |
Não |
Obtém a fonte de dados associada à lista, ou null se a lista não for uma lista virtual. Retorna null se a propriedade HasExternalDataSource é false. |
|
DefaultContentApprovalWorkflowId |
GUID |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica o identificador de fluxo de trabalho padrão para aprovação de conteúdos da lista. Retorna um GUID vazio se não há nenhum fluxo de trabalho de aprovação de conteúdo padrão. |
DefaultDisplayFormUrl |
String |
De leitura e gravação |
Não |
Obtém ou define um valor que especifica o local do formulário de exibição padrão para a lista. Os clientes especificam uma URL relativa do servidor e o servidor retorna uma URL relativa do site |
DefaultEditFormUrl |
String |
De leitura e gravação |
Não |
Obtém ou define um valor que especifica a URL do formulário de edição a ser usado para itens de lista na lista. Os clientes especificam uma URL relativa do servidor e o servidor retorna uma URL relativa do site. |
DefaultNewFormUrl |
String |
De leitura e gravação |
Não |
Obtém ou define um valor que especifica o local do novo formulário padrão para a lista. Os clientes especificam uma URL relativa do servidor e o servidor retorna uma URL relativa do site. |
DefaultView |
L |
Não |
||
DefaultViewUrl |
String |
L |
Não |
Obtém a URL do modo de exibição padrão para a lista. |
Description |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica a descrição da lista. |
Direction |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica a ordem de leitura da lista. Retorna "NONE", "LTR" ou "RTL". |
DocumentTemplateUrl |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica a URL relativa ao servidor do modelo de documento para a lista. Retorna uma URL relativa do servidor se o tipo base é DocumentLibrary; caso contrário, retorna null. |
DraftVersionVisibility |
Int32 |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica a permissão mínima necessária para visualizar versões secundárias e rascunhos contidos na lista. Representa um valor SP.DraftVisibilityType: Leitor = 0; Autor = 1; Aprovador = 2. |
EffectiveBasePermissions |
L |
Não |
Obtém um valor que especifica as permissões efetivas na lista que estão atribuídas ao usuário atual. |
|
EffectiveBasePermissionsForUI |
L |
Não |
||
EnableAttachments |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se os anexos de itens de lista estão habilitados para a lista. |
EnableFolderCreation |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se novas pastas de lista podem ser adicionadas à lista. |
EnableMinorVersions |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se versões secundárias estão habilitadas para a lista. |
EnableModeration |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se a aprovação de conteúdo está habilitada para a lista. |
EnableVersioning |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se versões históricas de itens e documentos de lista podem ser criadas na lista. |
EntityTypeName |
String |
L |
Sim |
|
EventReceivers |
SP.EventReceiverDefinitionCollection |
L |
Não |
|
Fields |
L |
Não |
Obtém um valor que especifica a coleção de todos os campos na lista. |
|
FirstUniqueAncestorSecurableObject |
SP.SecurableObject |
L |
Não |
Obtém o objeto no qual estão definidas atribuições de função para este objeto. Se as atribuições de função forem definidas diretamente no objeto atual, o objeto atual será retornado. |
ForceCheckout |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que indica se o check-out forçado está habilitado para a biblioteca de documentos. |
Forms |
SP.FormCollection |
L |
Não |
Obtém um valor que especifica a coleção de todos os formulários de lista na lista. |
HasExternalDataSource |
Boolean |
L |
Sim |
Obtém um valor que especifica se a lista é uma lista externa. |
HasUniqueRoleAssignments |
Boolean |
L |
Não |
Obtém um valor que especifica se as atribuições de função são definidas exclusivamente para este objeto protegível ou herdados de um objeto protegível pai. |
Hidden |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor Booliano que especifica se a lista está oculta. Se for true, o servidor definirá a propriedade OnQuickLaunch como false. |
Id |
GUID |
L |
Sim |
Obtém o GUID que identifica a lista no banco de dados. |
ImageUrl |
String |
L |
Sim |
Obtém um valor que especifica a URI para o ícone da lista. |
InformationRightsManagementSettings |
SP.InformationRightsManagementSettings |
L |
Não |
|
IrmEnabled |
Boolean |
De leitura e gravação |
Sim |
|
IrmExpire |
Boolean |
De leitura e gravação |
Sim |
|
IrmReject |
Boolean |
De leitura e gravação |
Sim |
|
IsApplicationList |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica um sinalizador que um aplicativo cliente pode usar para determinar se deverá exibir a lista. |
IsCatalog |
Boolean |
L |
Sim |
Obtém um valor que especifica se uma lista é uma galeria. |
IsPrivate |
Boolean |
L |
Sim |
|
IsSiteAssetsLibrary |
Boolean |
L |
Não |
Obtém um valor que indica se a lista é designada como uma localização de ativo padrão para imagens ou outros arquivos que os usuários carreguem para suas páginas wiki. |
ItemCount |
Int32 |
L |
Sim |
Obtém um valor que especifica o número de itens de lista na lista. |
Items |
L |
Não |
Obtém todos os itens na lista. Você pode usar operações de consulta OData para filtrar itens (exemplo: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5). |
|
LastItemDeletedDate |
DateTime |
L |
Sim |
Obtém um valor que especifica a última vez que um item de lista foi excluído da lista. |
LastItemModifiedDate |
DateTime |
De leitura e gravação |
Sim |
Obtém o valor que especifica a última vez que um item, campo ou propriedade da lista foram modificados. |
ListItemEntityTypeFullName |
String |
L |
Sim |
|
MultipleDataList |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que indica se a lista em um site de Espaço de Trabalho de Reunião contém dados para múltiplas instâncias de reunião dentro do site. |
NoCrawl |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica que o rastreador não deve rastrear a lista. |
OnQuickLaunch |
Boolean |
De leitura e gravação |
Não |
Obtém ou define um valor que especifica se a lista é exibida no Início Rápido do site. Se for true, o servidor definirá a propriedade Hidden como false. |
ParentWeb |
L |
Não |
Obtém um valor que especifica o site que contém a lista. |
|
ParentWebUrl |
String |
L |
Sim |
Obtém um valor que especifica a URL relativa ao servidor do site que contém a lista. |
RoleAssignments |
L |
Não |
Obtém as atribuições de função para o objeto protegível. |
|
RootFolder |
L |
Não |
Obtém a pasta raiz que contém os arquivos na lista e quaisquer arquivos relacionados. |
|
SchemaXml |
String |
L |
Não |
Obtém um valor que especifica o esquema de lista da lista. |
ServerTemplateCanCreateFolders |
Boolean |
L |
Sim |
Obtém um valor que indica se pastas podem ser criadas na lista. |
TemplateFeatureId |
GUID |
L |
Sim |
Obtém um valor que especifica o identificador de recurso do recurso que contém o esquema de lista para a lista. Retorna um GUID vazio se o esquema de lista não está contido em um recurso. |
Título |
String |
De leitura e gravação |
Sim |
Obtém ou define o título exibido para a lista. O tamanho deve ser <= 255 caracteres. |
UserCustomActions |
L |
Não |
Obtém um valor que especifica a coleção de todas as ações personalizadas de usuário para a lista. |
|
ValidationFormula |
String |
De leitura e gravação |
Não |
Obtém ou define um valor que especifica os critérios de validação de dados para um item de lista. O tamanho deve ser <= 1023. |
ValidationMessage |
String |
De leitura e gravação |
Não |
Obtém ou define um valor que especifica a mensagem de erro retornada quando a validação de dados falha para um item de lista. O tamanho deve ser <= 1023. |
Views |
L |
Não |
Obtém o valor que especifica a coleção de todos os modos de exibição públicos na lista e modos de exibição pessoais do usuário atual na lista. |
|
WorkflowAssociations |
SP.Workflow.WorkflowAssociationCollection |
L |
Não |
Obtém um valor que especifica a coleção de todas as associações de fluxos de trabalho para a lista. |
Métodos de List
AddItem
BreakRoleInheritance
DeleteObject
GetChanges
GetItemById
GetItems
GetListItemChangesSinceToken
GetRelatedFields
GetUserEffectivePermissions
GetView
Recycle
RenderListData
RenderListFormData
ReserveListItemId
ResetRoleInheritance
Método AddItem
Exemplos
Método BreakRoleInheritance
Cria atribuições de função exclusivas para o objeto protegível.
Ponto de extremidade |
/breakroleinheritance(copyroleassignments, clearsubscopes) |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
/breakroleinheritance(copyroleassignments=false, clearsubscopes=true)
?@target='<host web url>'",
method: "POST",
success: successHandler,
error: errorHandler
});
Método DeleteObject
Exemplos
Método GetChanges
Retorna a coleção de alterações do log de alterações que tenham ocorrido na lista, com base na consulta especificada.
Ponto de extremidade |
/getchanges |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Tipo: SP.ChangeCollection |
Exemplo de solicitação
var metadata = "{ 'query' : { '__metadata': { 'type': 'SP.ChangeQuery' },
'Add': 'True', 'Item': 'True' }}";
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/getchanges
?@target='<host web url>'",
method: "POST",
body: metadata,
headers: {
"accept": "application/json; odata=verbose",
"content-type": "application/json; odata=verbose"
},
success: successHandler,
error: errorHandler
});
Exemplo de resposta
{"d":
{"results":[{
"__metadata":{
"id":"https://<site url>/_api/SP.ChangeItema7e7c6e9-2c41-47c3-aae9-2b4a63b7a087",
"uri":"https://<site url>/_api/SP.ChangeItem",
"type":"SP.ChangeItem"
},
"ChangeToken":{"__metadata":{"type":"SP.ChangeToken"}, "StringValue":"1;3;482e418a-0900-414b-8902-02248c2e44e8;634955266749500000;5749111"},
"ChangeType":1,
"SiteId":"ce11bfbb-cf9d-4b2b-a642-8673bd48cceb",
"Time":"2013-02-03T22:17:54Z",
"ItemId":1,
"ListId":"482e418a-0900-414b-8902-02248c2e44e8",
"WebId":"a975b994-fc67-4203-a519-b160175ca967"
}]
}}
Método GetItemById
Retorna o item de lista com o identificador de item de lista especificado.
Ponto de extremidade |
/getitembyid(<item id>) |
Parâmetros |
Tipo: Int32 |
HTTP method |
GET |
Resposta |
Tipo: SP.ListItem |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
/getitembyid(2)
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode passar a ID do item de lista para o recurso ListItemCollection. Exemplo: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items(2).
Método GetItems
Retorna uma coleção de itens da lista com base na consulta especificada.
Ponto de extremidade |
/getitems |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Tipo: SP.ListItemCollection |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
/getitems
?@target='<host web url>'",
method: "POST",
body: "{ 'query' : {'__metadata': { 'type': 'SP.CamlQuery' }, "ViewXml": "<View><Query><Where><Contains><FieldRef Name='Status'/><Value Type='CHOICE'>in progress</Value></Contains></Where></Query></View>" } }",
headers: {
"accept": "application/json; odata=verbose",
"content-type": "application/json; odata=verbose"
},
success: successHandler,
error: errorHandler
});
Método GetListItemChangesSinceToken
Ponto de extremidade |
/getlistitemchangessincetoken |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Tipo: GetListItemChangesSinceTokenResult |
Exemplo de solicitação
var metadata = "{ 'query': { '__metadata': { 'type': 'SP.ChangeLogItemQuery' },
'ChangeToken': '1;3;79cc20e6-adda-438e-8a96-792041b33168;635103901830230000;33050019' }}";
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/getlistitemchangessincetoken
?@target='<host web url>'",
method: "POST",
body: metadata,
headers: { "content-type": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Veja Sincronizar os itens do SharePoint usando o serviço REST para obter um exemplo de como especificar uma consulta filtrada.
Exemplo de resposta
<?xml version="1.0" encoding="utf-8" ?>
<GetListItemChangesSinceTokenResult>
<listitems MinTimeBetweenSyncs='0' RecommendedTimeBetweenSyncs='180' MaxBulkDocumentSyncSize='500' MaxRecommendedEmbeddedFileSize='500' EffectivePermMask='FullMask' xmlns:s='uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882' xmlns:dt='uuid:C2F41010-65B3-11d1-A29F-00AA00C14882' xmlns:rs='urn:schemas-microsoft-com:rowset' xmlns:z='#RowsetSchema'>
<Changes LastChangeToken="1;3;79cc20e6-adda-438e-8a96-792041b33168;635110802324330000;33811711">
<List DocTemplateUrl="" DefaultViewUrl="/Lists/TestList/AllItems.aspx" MobileDefaultViewUrl="" ID="{79CC20E6-ADDA-438E-8A96-792041B33168}" Title="TestList" Description="" ImageUrl="/_layouts/15/images/itgen.png?rev=26" Name="{79CC20E6-ADDA-438E-8A96-792041B33168}" BaseType="0" FeatureId="00bfea71-de22-43b2-a848-c05709900100" ServerTemplate="100" Created="20130725 22:22:35" Modified="20130802 22:43:52" LastDeleted="20130725 22:22:35" Version="4" Direction="none" ThumbnailSize="" WebImageWidth="" WebImageHeight="" Flags="545263616" ItemCount="2" AnonymousPermMask="0" RootFolder="/Lists/TestList" ReadSecurity="1" WriteSecurity="1" Author="11" EventSinkAssembly="" EventSinkClass="" EventSinkData="" EmailAlias="" WebFullUrl="/" WebId="a975b994-fc67-4203-a519-b160175ca967" SendToLocation="" ScopeId="ad9949be-be16-4946-b5de-66c912eda54a" MajorVersionLimit="0" MajorWithMinorVersionsLimit="0" WorkFlowId="" HasUniqueScopes="False" NoThrottleListOperations="False" HasRelatedLists="" Followable="False" AllowDeletion="True" AllowMultiResponses="False" EnableAttachments="True" EnableModeration="False" EnableVersioning="False" HasExternalDataSource="False" Hidden="False" MultipleDataList="False" Ordered="False" ShowUser="True" EnablePeopleSelector="False" EnableResourceSelector="False" EnableMinorVersion="False" RequireCheckout="False" ThrottleListOperations="False" ExcludeFromOfflineClient="False" CanOpenFileAsync="True" EnableFolderCreation="False" IrmEnabled="False" IsApplicationList="False" PreserveEmptyValues="False" StrictTypeCoercion="False" EnforceDataValidation="False" MaxItemsPerThrottledOperation="5000">
<Fields>
<Field ID="{03e45e84-1992-4d42-9116-26f756012634}" RowOrdinal="0" Type="ContentTypeId" Sealed="TRUE" ReadOnly="TRUE" Hidden="TRUE" DisplayName="Content Type ID" Name="ContentTypeId" DisplaceOnUpgrade="TRUE" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="ContentTypeId" ColName="tp_ContentTypeId" FromBaseType="TRUE"/>
<Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="Title" Required="TRUE" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="Title" FromBaseType="TRUE" ColName="nvarchar1"/>
<Field ID="{34ad21eb-75bd-4544-8c73-0e08330291fe}" ReadOnly="TRUE" Type="Note" Name="_ModerationComments" DisplayName="Approver Comments" Hidden="TRUE" CanToggleHidden="TRUE" Filterable="FALSE" Sortable="FALSE" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="_ModerationComments" FromBaseType="TRUE" ColName="ntext1"/>
<Field ID="{39360f11-34cf-4356-9945-25c44e68dade}" ReadOnly="TRUE" Hidden="TRUE" Type="Text" Name="File_x0020_Type" DisplaceOnUpgrade="TRUE" DisplayName="File Type" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="File_x0020_Type" FromBaseType="TRUE" ColName="nvarchar2"/>
<Field ID="{fc2e188e-ba91-48c9-9dd3-16431afddd50}" Name="WorkAddress" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="WorkAddress" Group="Core Contact and Calendar Columns" DisplayName="Address" Type="Note" NumLines="2" Sortable="FALSE" ColName="ntext2" RowOrdinal="0"/>
<Field ID="{fce16b4c-fe53-4793-aaab-b4892e736d15}" Name="EMail" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="EMail" Group="Core Contact and Calendar Columns" DisplayName="E-Mail" ReadOnly="FALSE" Type="Text" FromBaseType="TRUE" AllowDeletion="TRUE" ColName="nvarchar3" RowOrdinal="0"/>
<Field Type="Lookup" DisplayName="anewishlisttitle" Required="FALSE" EnforceUniqueValues="FALSE" List="{482e418a-0900-414b-8902-02248c2e44e8}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{9919f3f8-88fb-43fc-b4cb-658b1db1bfe3}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="anewishlisttitle" Name="anewishlisttitle" ColName="int1" RowOrdinal="0"/>
<Field Type="Lookup" DisplayName="Books title" Required="FALSE" EnforceUniqueValues="FALSE" List="{90146606-81fd-410d-9fdd-d03b6349fbcd}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{879a1cba-91b6-4c0a-99fb-29f877aae3ea}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="Books_x0020_title" Name="Books_x0020_title" ColName="int2" RowOrdinal="0"/>
<Field ID="{1d22ea11-1e32-424e-89ab-9fedbadb6ce1}" ColName="tp_ID" RowOrdinal="0" ReadOnly="TRUE" Type="Counter" Name="ID" PrimaryKey="TRUE" DisplayName="ID" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="ID" FromBaseType="TRUE"/>
<Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Type="Computed" DisplayName="Content Type" Name="ContentType" DisplaceOnUpgrade="TRUE" RenderXMLUsingPattern="TRUE" Sortable="FALSE" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="_Hidden" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" FromBaseType="TRUE">
<FieldRefs>
<FieldRef Name="ContentTypeId"/>
</FieldRefs>
<DisplayPattern>
<MapToContentType>
<Column Name="ContentTypeId"/>
</MapToContentType>
</DisplayPattern>
</Field>
<…>
</Fields>
<RegionalSettings>
<Language>1033</Language>
<Locale>1033</Locale>
<AdvanceHijri>0</AdvanceHijri>
<CalendarType>1</CalendarType>
<Time24>False</Time24>
<TimeZone>480</TimeZone>
<SortOrder>2070</SortOrder>
<Presence>True</Presence>
</RegionalSettings>
<ServerSettings>
<ServerVersion>16.0.1810.1236</ServerVersion>
<RecycleBinEnabled>True</RecycleBinEnabled>
<ServerRelativeUrl>/</ServerRelativeUrl>
</ServerSettings>
</List>
</Changes>
<rs:data ItemCount="1">
<z:row ows_ContentTypeId='0x0100C8CFB1DE383F1B49A44ABD2EB9AC7322' ows_Title='<item title>' ows_ID='2' ows_ContentType='Item' ows_Modified='2013-07-25T23:21:50Z' ows_Created='2013-07-25T23:21:50Z' ows_Author='<author>' ows_Editor='<editor>' ows_owshiddenversion='1' ows_WorkflowVersion='1' ows__UIVersion='512' ows__UIVersionString='1.0' ows_Attachments='0' ows__ModerationStatus='0' ows_LinkTitleNoMenu='<item title>' ows_LinkTitle='<item title>' ows_LinkTitle2='<item title>' ows_SelectTitle='2' ows_Order='200.000000000000' ows_GUID='{D38981C3-2735-4FDF-9B41-91F3ADA8F3F0}' ows_FileRef='2;#Lists/TestList/2_.000' ows_FileDirRef='2;#Lists/TestList' ows_Last_x0020_Modified='2;#2013-07-25T23:21:50Z' ows_Created_x0020_Date='2;#2013-07-25T23:21:50Z' ows_FSObjType='2;#0' ows_SortBehavior='2;#0' ows_PermMask='0x7fffffffffffffff' ows_FileLeafRef='2;#2_.000' ows_UniqueId='2;#{4D719C3B-B8AB-46A0-A080-402DF6EE31C1}' ows_ProgId='2;#' ows_ScopeId='2;#{AD9949BE-BE16-4946-B5DE-66C912EDA54A}' ows__EditMenuTableStart='2_.000' ows__EditMenuTableStart2='2' ows__EditMenuTableEnd='2' ows_LinkFilenameNoMenu='2_.000' ows_LinkFilename='2_.000' ows_LinkFilename2='2_.000' ows_ServerUrl='/Lists/TestList/2_.000' ows_EncodedAbsUrl='https://<site url>.sharepoint.com/Lists/TestList/2_.000' ows_BaseName='2_' ows_MetaInfo='2;#' ows__Level='1' ows__IsCurrentVersion='1' ows_ItemChildCount='2;#0' ows_FolderChildCount='2;#0' ows_ServerRedirected='0' />
</rs:data>
</listitems>
</GetListItemChangesSinceTokenResult>
Método GetRelatedFields
Retorna uma coleção de campos Pesquisa que usam essa lista como uma fonte de dados e que têm FieldLookup.IsRelationship definido como true.
Ponto de extremidade |
/getrelatedfields |
Parâmetros |
Nenhum |
HTTP method |
GET |
Resposta |
Tipo: SP.RelatedFieldCollection |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/getrelatedfields
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método GetUserEffectivePermissions
Ponto de extremidade |
/getusereffectivepermissions(@user)?@user='<user login name>' |
Parâmetros |
Tipo: String |
HTTP method |
GET |
Resposta |
Tipo: SP.BasePermissions |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/getusereffectivepermissions(@user)?@user='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
&@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método GetView
Retorna o modo de exibição de lista com o identificador de modo de exibição especificado.
Ponto de extremidade |
/getview('<view id>') |
Parâmetros |
Tipo: String |
HTTP method |
GET |
Resposta |
Tipo: SP.View |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/getview('4814949d-3e17-444c-a1a3-cb69bc77e95f')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode especificar apenas a ID do modo de exibição no recurso ViewCollection. Exemplo: …/_api/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('4814949d-3e17-444c-a1a3-cb69bc77e95f')
Método Recycle
Move a lista para a lixeira e retorna o identificador do novo item de Lixeira.
Ponto de extremidade |
/recycle |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Tipo: GUID |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/recycle
?@target='<host web url>'",
method: "POST",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método RenderListData
Ponto de extremidade |
/renderlistdata('<view xml>') |
Parâmetros |
Tipo: String |
HTTP method |
POST |
Resposta |
Tipo: String |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/renderlistdata(@viewXml)?@viewXml='<View><RowLimit>10</RowLimit></View>'
&@target='<host web url>'",
method: "POST",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método RenderListFormData
Ponto de extremidade |
/renderlistformdata(itemid, formid, mode) |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Tipo: String |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/renderlistformdata(itemid=4, formid='e8b2f6e3-1081-4b18-833b-475f76473cde', mode=2)
?@target='<host web url>'",
method: "POST",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método ReserveListItemId
Reserva uma ID do item de lista para a criação de item de lista idempotente.
Ponto de extremidade |
/reservelistitemid |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Tipo: Int32 |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
/reservelistitemid
?@target='<host web url>'",
method: "POST",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método ResetRoleInheritance
Redefine a herança de função para o objeto protegível e herda atribuições de função do objeto protegível pai.
Ponto de extremidade |
/resetroleinheritance |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
/resetroleinheritance
?@target='<host web url>'",
method: "POST",
success: successHandler,
error: errorHandler
});
Representação do OData
O exemplo a seguir representa um recurso List no formato JSON.
{"d":{
"__metadata":{
"id":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
"etag":"\"0\"",
"type":"SP.List"
},
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/RoleAssignments"}},
"ContentTypes":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/ContentTypes"}},
"DefaultView":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/DefaultView"}},
"EventReceivers":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/EventReceivers"}},
"Fields":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Fields"}},
"Forms":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Forms"}},
"InformationRightsManagementSettings":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/InformationRightsManagementSettings"}},
"AllowContentTypes":true,
"BaseTemplate":100,
"BaseType":0,
"ContentTypesEnabled":false,
"Created":"2013-02-02T21:11:56Z",
"DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
"Description":"",
"Direction":"none",
"DocumentTemplateUrl":null,
"DraftVersionVisibility":0,
"EnableAttachments":true,
"EnableFolderCreation":false,
"EnableMinorVersions":false,
"EnableModeration":false,
"EnableVersioning":false,
"EntityTypeName":"ANewList",
"ForceCheckout":false,
"HasExternalDataSource":false,
"Hidden":false,
"Id":"8ade7551-f53c-48c5-9d2b-e89f6528cf47",
"ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
"IrmEnabled":false,
"IrmExpire":false,
"IrmReject":false,
"IsApplicationList":false,
"IsCatalog":false,
"IsPrivate":false,
"ItemCount":1,
"LastItemDeletedDate":"2013-02-02T21:11:56Z",
"LastItemModifiedDate":"2013-02-03T22:17:55Z",
"ListItemEntityTypeFullName":"SP.Data.ANewListItem",
"MultipleDataList":false,
"NoCrawl":false,
"ParentWebUrl":"/",
"ServerTemplateCanCreateFolders":true,
"TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
"Title":"ANewList"
}}
Recurso ListCollection
Representa uma coleção de listas.
URI do ponto de extremidade | Métodos | Representação do OData
URI do ponto de extremidade
http://<site url>/web/lists
Métodos HTTP com suporte
GET | POST
Exemplos de solicitação
Exemplo de solicitação GET: Obter as listas no site raiz
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Exemplo de solicitação GET: Obter uma lista por título
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists/getbytitle('Access Requests')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Exemplo de solicitação GET: Obter uma lista por ID
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Exemplo de solicitação POST: Criar uma lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
headers: { "content-type": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
Métodos ListCollection
EnsureSiteAssetsLibrary
EnsureSitePagesLibrary
GetById
GetByTitle
Método EnsureSiteAssetsLibrary
Obtém uma lista que é a localização padrão do ativo para imagens ou outros arquivos que os usuários carregam para suas páginas wiki.
Ponto de extremidade |
/ensuresiteassetslibrary |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Tipo: SP.List |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
/ensuresiteassetslibrary
?@target='<host web url>'",
method: "POST",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método EnsureSitePagesLibrary
Obtém uma lista que é a localização padrão para páginas wiki.
Ponto de extremidade |
/ensuresitepageslibrary |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Tipo: SP.List |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
/ensuresitepageslibrary
?@target='<host web url>'",
method: "POST",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método GetById
Retorna a lista com o identificador de lista especificado.
Ponto de extremidade |
/getbyid |
Parâmetros |
Tipo: String |
HTTP method |
GET |
Resposta |
Tipo: SP.List |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
/getbyid('51925dd7-2108-481a-b1ef-4bfa4e69d48b')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode passar apenas a ID da lista para o recurso ListCollection. Exemplo: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b').
Método GetByTitle
Retorna a lista com o título especificado da coleção.
Ponto de extremidade |
/getbytitle |
Parâmetros |
Tipo: String |
HTTP method |
GET |
Resposta |
Tipo: SP.List |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
/getbytitle('Access Requests')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Representação do OData
O exemplo a seguir representa um recurso ListCollection no formato JSON.
{"d":{
"results":[{
"__metadata":{"id":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')",
"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-
4bfa4e69d48b')",
"etag":"\"6\"",
"type":"SP.List"
},
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RoleAssignments"}},
"ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ContentTypes"}},
"DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/DefaultView"}},
"EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/EventReceivers"}},
"Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Fields"}},
"Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Forms"}},
"InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/InformationRightsManagementSettings"}},
"Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Items"}},
"ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ParentWeb"}},
"RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RootFolder"}},
"UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/UserCustomActions"}},
"Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Views"}},
"WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/WorkflowAssociations"}},
"AllowContentTypes":true,
"BaseTemplate":160,"BaseType":0,
"ContentTypesEnabled":true,
"Created":"2013-06-10T17:14:49Z",
"DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
"Description":"Use this list to track access requests to a site or uniquely permissioned items in the site.",
"Direction":"none",
"DocumentTemplateUrl":null,
"DraftVersionVisibility":0,
"EnableAttachments":false,
"EnableFolderCreation":false,
"EnableMinorVersions":false,
"EnableModeration":false,
"EnableVersioning":true,
"EntityTypeName":"Access_x0020_Requests",
"ForceCheckout":false,
"HasExternalDataSource":false,
"Hidden":true,
"Id":"51925dd7-2108-481a-b1ef-4bfa4e69d48b",
"ImageUrl":"/_layouts/15/images/itgen.gif?rev=26",
"IrmEnabled":false,
"IrmExpire":false,
"IrmReject":false,
"IsApplicationList":false,
"IsCatalog":false,
"IsPrivate":false,
"ItemCount":3,
"LastItemDeletedDate":"2013-06-10T17:14:49Z",
"LastItemModifiedDate":"2013-06-10T17:20:48Z",
"ListItemEntityTypeFullName":"SP.Data.Access_x0020_RequestsItem",
"MultipleDataList":false,
"NoCrawl":true,
"ParentWebUrl":"/",
"ServerTemplateCanCreateFolders":true,
"TemplateFeatureId":"a0f12ee4-9b60-4ba4-81f6-75724f4ca973",
"Title":"Access Requests"},
{
"__metadata":{
"id":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')",
"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-
02248c2e44e8')",
"etag":"\"1\"",
"type":"SP.List"
},
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-
02248c2e44e8')/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RoleAssignments"}},
"ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ContentTypes"}},
"DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/DefaultView"}},
"EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/EventReceivers"}},
"Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Fields"}},
"Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Forms"}},
"InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/InformationRightsManagementSettings"}},
"Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Items"}},
"ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ParentWeb"}},
"RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RootFolder"}},
"UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/UserCustomActions"}},
"Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Views"}},
"WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/WorkflowAssociations"}},
"AllowContentTypes":true,
"BaseTemplate":100,
"BaseType":0,
"ContentTypesEnabled":false,
"Created":"2013-02-02T21:11:56Z",
"DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
"Description":"",
"Direction":"none",
"DocumentTemplateUrl":null,
"DraftVersionVisibility":0,
"EnableAttachments":true,
"EnableFolderCreation":false,
"EnableMinorVersions":false,
"EnableModeration":false,
"EnableVersioning":false,
"EntityTypeName":"AList",
"ForceCheckout":false,
"HasExternalDataSource":false,
"Hidden":false,
"Id":"482e418a-0900-414b-8902-02248c2e44e8",
"ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
"IrmEnabled":false,
"IrmExpire":false,
"IrmReject":false,
"IsApplicationList":false,
"IsCatalog":false,
"IsPrivate":false,
"ItemCount":3,
"LastItemDeletedDate":"2013-02-02T21:11:56Z",
"LastItemModifiedDate":"2013-06-26T22:31:03Z",
"ListItemEntityTypeFullName":"SP.Data.AListListItem",
"MultipleDataList":false,
"NoCrawl":false,
"ParentWebUrl":"/",
"ServerTemplateCanCreateFolders":true,
"TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
"Title":"AList"
}]
}}
Recurso ListItem
Representa um item ou linha em uma lista. Um item de lista é um tipo de SP.SecurableObject.
URI do ponto de extremidade | Propriedades | Métodos | Representação do OData
Observação
A opção de consulta OData $skip não funciona com esse ponto de extremidade.
URI do ponto de extremidade
http://<site url>/web/lists(guid'<list id>')/items(<item id>)
http://<site url>/web/lists/getbytitle('<list title>')/items(<item id>)
Métodos HTTP com suporte
GET | POST | DELETE | MERGE
Exemplos de solicitação
Exemplo de solicitação GET: Obter um item de lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Exemplo de solicitação POST: Criar um item de lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
'PredecessorsId': {"results":[4]}}",
headers: {
"accept": "application/json;odata=verbose",
"content-type": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
Observação
Para criar ou alterar um item de lista, você precisa conhecer a propriedade ListItemEntityTypeFullName da lista e passa-la como o valor de type no corpo da solicitação HTTP.
Exemplos
Exemplo de solicitação MERGE: Alterar um item de lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
'Priority': '(1) High', 'Status': 'In Progress', 'PercentComplete': 0.3 }",
headers: {
"IF-MATCH": "*",
"content-type": "application/json;odata=verbose",
"X-HTTP-Method": "MERGE"
},
success: successHandler,
error: errorHandler
});
Observação
Para criar ou alterar um item de lista, você precisa conhecer a propriedade ListItemEntityTypeFullName da lista e passa-la como o valor de type no corpo da solicitação HTTP.
Exemplo de solicitação DELETE: Excluir um item de lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
?@target='<host web url>'",
method: "POST",
headers: {
"IF-MATCH": "*",
"X-HTTP-Method": "DELETE"
},
success: successHandler,
error: errorHandler
});
Se você deseja obter o GUID da operação de reciclagem, use o método Recycle do item.
Propriedades de ListItem
Propriedade |
Tipo |
De leitura/gravação |
Descrição |
|
|---|---|---|---|---|
AttachmentFiles |
SP.AttachmentCollection |
L |
Não |
Especifica a coleção de anexos que são associados ao item de lista. |
ContentType |
SP.ContentType |
L |
Não |
Obtém um valor que especifica o tipo de conteúdo do item de lista. |
DisplayName |
String |
L |
Sim (exibido como o valor "Title") |
Obtém um valor que especifica o nome de exibição do item de lista. |
EffectiveBasePermissions |
L |
Sim |
Obtém um valor que especifica as permissões efetivas no item de lista atribuídas ao usuário atual. |
|
EffectiveBasePermissionsForUI |
L |
Sim |
Obtém as permissões base efetivas para o usuário atual, do modo como deverão ser exibidas na IU. |
|
FieldValuesAsHtml |
SP.FieldStringValues |
L |
Não |
Obtém os valores para o item de lista como HTML. |
FieldValuesAsText |
SP.FieldStringValues |
L |
Não |
Obtém os valores de campo da lista como uma coleção de valores de cadeia de caracteres. |
FieldValuesForEdit |
SP.FieldStringValues |
L |
Não |
Obtém os valores formatados a serem exibidos em um formulário de edição. |
File |
L |
Não |
Obtém o arquivo que é representado pelo item em uma biblioteca de documentos. |
|
FileSystemObjectType |
Int32 |
L |
Sim |
Obtém um valor que especifica se o item de lista é um arquivo ou uma pasta de lista. Representa um valor SP.FileSystemObjectType: Inválido = -1; Arquivo = 0; Pasta = 1; Web = 2. |
FirstUniqueAncestorSecurableObject |
SP.SecurableObject |
L |
Não |
Obtém o objeto no qual estão definidas atribuições de função para este objeto. Se as atribuições de função forem definidas diretamente no objeto atual, o objeto atual será retornado. |
Folder |
L |
Não |
Obtém um objeto de pasta que está associado a um item de pasta. |
|
HasUniqueRoleAssignments |
Boolean |
L |
Não |
Obtém um valor que especifica se as atribuições de função são definidas exclusivamente para este objeto protegível ou herdados de um objeto protegível pai. |
Id |
Int32 |
L |
Sim |
Obtém um valor que especifica o identificador de item de lista. |
ParentList |
L |
Não |
Obtém uma lista pai que contém o item de lista. |
|
RoleAssignments |
L |
Não |
Obtém as atribuições de função para o objeto protegível. |
Métodos de ListItem
BreakRoleInheritance
DeleteObject
GetUserEffectivePermissions
Recycle
ResetRoleInheritance
ValidateUpdateListItem
Método BreakRoleInheritance
Cria atribuições de função exclusivas para o objeto protegível.
Ponto de extremidade |
/breakroleinheritance(copyroleassignments, clearsubscopes) |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
/breakroleinheritance(copyroleassignments=true, clearsubscopes=false)
?@target='<host web url>'",
method: "POST",
success: successHandler,par
error: errorHandler
});
Método DeleteObject
Exemplos
Método GetUserEffectivePermissions
Obtém as permissões efetivas que um usuário tem no item de lista.
Ponto de extremidade |
/getusereffectivepermissions(@v)?@v='<user login name>' |
Parâmetros |
Tipo: String |
HTTP method |
GET |
Resposta |
Tipo: SP.BasePermissions |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
/getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
&@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método Recycle
Move o item de lista para a Lixeira e retorna o identificador do novo item de Lixeira.
Ponto de extremidade |
/recycle |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Tipo: GUID |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
/recycle
?@target='<host web url>'",
method: "POST",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Método ResetRoleInheritance
Redefine a herança de função para o objeto protegível e herda atribuições de função do objeto protegível pai.
Ponto de extremidade |
/resetroleinheritance |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
/resetroleinheritance
?@target='<host web url>'",
method: "POST",
success: successHandler,
error: errorHandler
});
Método ValidateUpdateListItem
Valida e define os valores da coleção de campos especificado para o item de lista.
Ponto de extremidade |
/validateupdatelistitem |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Tipo: SP.ListItemFormUpdateValue[] |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
/validateupdatelistitem
?@target='<host web url>'",
method: "POST",
body: "{ 'formValues':[{'FieldName':'Status', 'FieldValue':'Deferred'},
{'FieldName':'StartDate', 'FieldValue':'12/31/2014'}], 'bNewDocumentUpdate': false }",
headers: {
"accept": "application/json; odata=verbose",
"content-type": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
Exemplo de resposta
{"d":{
"ValidateUpdateListItem":{"results":[
{
"__metadata":{"type":"SP.ListItemFormUpdateValue"},
"ErrorMessage":null,
"FieldName":"Status",
"FieldValue":"Deferred",
"HasException":false
},{
"__metadata":{"type":"SP.ListItemFormUpdateValue"},
"ErrorMessage":null,
"FieldName":"StartDate",
"FieldValue":"12/31/2014",
"HasException":false
}
]}
}}
Representação do OData
O exemplo a seguir representa um recurso ListItem no formato JSON. O recurso também retorna seus valores de campo.
{"d":{
"__metadata":{,
"id":"2bbdaee6-1172-4e36-9f90-ce35ec9b6207",
"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
"etag":"\"1\"",
"type":"SP.Data.Team_x0020_tasksListItem"
},
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
"AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
"ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
"FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
"FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
"FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
"File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
"Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
"ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
"FileSystemObjectType":0,
"Id":2,
"ID":2,
"ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
"Title":"Assign teams",
"Modified":"2013-09-03T17:50:30Z",
"Created":"2013-09-03T17:50:30Z",
"AuthorId":1073741823,
"EditorId":1073741823,
"OData__UIVersionString":"1.0",
"Attachments":false,
"GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
"PredecessorsId":{"results":[1]},
"Priority":"(2) Normal",
"Status":"Not Started",
"PercentComplete":0,
"AssignedToId":{"results":[1]},
"Body":null,
"StartDate":"2014-01-02T08:00:00Z",
"DueDate":"2014-01-02T08:00:00Z",
"Checkmark":"0",
"RelatedItems":null
}}
Recurso ListItemCollection
Representa uma coleção de recursos ListItem.
URI do ponto de extremidade | Métodos | Representação do OData
URI do ponto de extremidade
http://<site url>/web/lists(guid'<list id>')/items
http://<site url>/web/lists/getbytitle('<list title>')/items
Métodos HTTP com suporte
GET | POST
Exemplos de solicitação
Exemplo de solicitação GET: Obter todos os itens de lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Exemplo de solicitação GET: Obter um item de lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Você pode usar operações de consulta OData para filtrar itens específicos (exemplo: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5).
Exemplo de solicitação POST: Criar um item de lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
'PredecessorsId': {"results":[4]} }",
headers: {
"accept": "application/json;odata=verbose",
"content-type": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
Observação
Para criar ou alterar um item de lista, você precisa conhecer a propriedade ListItemEntityTypeFullName da lista e passa-la como o valor de type no corpo da solicitação HTTP.
Exemplos
Métodos de ListItemCollection
Método GetById
Retorna o item de lista com o identificador de item de lista especificado.
Ponto de extremidade |
/getbyid(<item id>) |
Parâmetros |
Tipo: Int32 |
HTTP method |
GET |
Resposta |
Tipo: SP.ListItem |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
/getbyid(2)
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode especificar apenas a ID do item de lista para o recurso ListItemCollection. Exemplo: …/_api/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
Representação do OData
O exemplo a seguir representa um recurso ListItemCollection no formato JSON, que retorna uma coleção de recursos ListItem.
{"d":{
"results":[{
"__metadata":{
"id":"dd9ab60c-4653-4654-85de-1d090f0d416f",
"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)",
"etag":"\"1\"",
"type":"SP.Data.Team_x0020_tasksListItem"
},
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/RoleAssignments"}},
"AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/AttachmentFiles"}},
"ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ContentType"}},
"FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsHtml"}},
"FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsText"}},
"FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesForEdit"}},
"File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/File"}},
"Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/Folder"}},
"ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ParentList"}},
"FileSystemObjectType":0,
"Id":1,
"ID":1,
"ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
"Title":"Triage requests",
"Modified":"2013-09-03T17:49:26Z",
"Created":"2013-09-03T17:49:26Z",
"AuthorId":1073741823,
"EditorId":1073741823,
"OData__UIVersionString":"1.0",
"Attachments":false,
"GUID":"e132ef1b-698e-4d21-ba1b-29fa5c38fe8e",
"PredecessorsId":{"results":[]},
"Priority":"(2) Normal",
"Status":"Not Started",
"PercentComplete":0,
"AssignedToId":{"results":[1,21]},
"Body":null,
"StartDate":"2014-01-01T08:00:00Z",
"DueDate":"2014-01-02T08:00:00Z",
"Checkmark":"0",
"RelatedItems":null
},{
"__metadata":{
"id":"687e63a4-ed44-4bf2-881f-c83e5d3fd020",
"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
"etag":"\"5\"",
"type":"SP.Data.Team_x0020_tasksListItem"
},
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
"AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
"ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
"FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
"FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
"FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
"File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
"Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
"ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
"FileSystemObjectType":0,
"Id":2,
"ID":2,
"ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
"Title":"Assign teams",
"Modified":"2013-09-03T19:24:51Z",
"Created":"2013-09-03T17:50:30Z",
"AuthorId":1073741823,
"EditorId":1073741823,
"OData__UIVersionString":"1.0",
"Attachments":false,
"GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
"PredecessorsId":{"results":[1]},
"Priority":"(1) High",
"Status":"In Progress",
"PercentComplete":0.3,
"AssignedToId":{"results":[1]},
"Body":null,
"StartDate":"2014-01-02T08:00:00Z",
"DueDate":"2014-01-02T08:00:00Z",
"Checkmark":"0",
"RelatedItems":null
},{
…
}]
}}
Recurso View
Especifica um modo de exibição de lista.
URI do ponto de extremidade | Propriedades | Métodos | Representação do OData
URI do ponto de extremidade
http://<site url>/_api/web/lists(guid'<list id>')/views('<view id>')
Métodos HTTP com suporte
GET | POST | DELETE | MERGE | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obter um modo de exibição
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode usar o método GetByTitle do recurso ViewCollection para obter um modo de exibição pelo título (que diferencia maiúsculas de minúsculas). Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').
Exemplo de solicitação MERGE: Alterar um modo de exibição
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'New Mobile Default View',
'MobileDefaultView': true, 'RowLimit': 5 }",
headers: {
"content-type": "application/json;odata=verbose",
"X-HTTP-Method": "MERGE"
},
success: successHandler,
error: errorHandler
});
Exemplo de solicitação DELETE: Excluir um modo de exibição
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
?@target='<host web url>'",
method: "POST",
headers: { "X-HTTP-Method": "DELETE" },
success: successHandler,
error: errorHandler
});
Exemplos
Propriedade de View
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade da propriedade, conforme mostrado no exemplo a seguir.
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/<property name>
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Propriedade |
Tipo |
De leitura/gravação |
Descrição |
|
|---|---|---|---|---|
Aggregations |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica campos e funções que definem totais exibidos em um modo de exibição de lista. Se não for nulo, o XML deverá estar em conformidade com FieldRefDefinitionAggregation, conforme especificado em [MS-WSSCAML]. |
AggregationsStatus |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se os totais são exibidos no modo de exibição de lista. |
BaseViewId |
String |
L |
Sim |
Obtém um valor que especifica o identificador de modo de exibição base do modo de exibição de lista. |
ContentTypeId |
De leitura e gravação |
Sim |
Obtém ou define o identificador do tipo de conteúdo com o qual o modo de exibição está associado para que o modo de exibição esteja disponível apenas em pastas deste tipo de conteúdo. |
|
DefaultView |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se o modo de exibição de lista é o modo de exibição de lista padrão. |
DefaultViewForContentType |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se o modo de exibição de lista é o modo de exibição padrão do tipo de conteúdo especificado pelo contentTypeId. |
EditorModified |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se o modo de exibição de lista foi modificado em um editor. |
Formats |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica a formatação de colunas e linhas para o modo de exibição de lista. Se não for nulo, o XML deverá estar em conformidade com ViewFormatDefinitions, conforme especificado em [MS-WSSCAML]. |
Hidden |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se o modo de exibição de lista será oculto. |
HtmlSchemaXml |
String |
L |
Sim |
Obtém um valor que especifica o documento XML que representa o modo de exibição de lista. |
Id |
GUID |
L |
Sim |
Obtém um valor que especifica o identificador de modo de exibição do modo de exibição de lista. |
ImageUrl |
String |
L |
Sim |
Obtém um valor que especifica a URI (Uniform Resource Identifier) da imagem para o modo de exibição de lista. |
IncludeRootFolder |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se a pasta atual é exibida no modo de exibição de lista. |
JsLink |
String |
De leitura e gravação |
Sim |
Obtém ou define o nome do arquivo JavaScript usado para o modo de exibição. |
ListViewXml |
String |
De leitura e gravação |
Sim |
Obtém ou define uma cadeia de caracteres que representa o modo de exibição XML. |
Method |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica o método de modo de exibição para o modo de exibição de lista. Se não for nulo, o XML deverá estar em conformidade com Method, conforme especificado em [MS-WSSCAP]. |
MobileDefaultView |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se o modo de exibição de lista é o modo de exibição de lista móvel padrão. |
MobileView |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se o modo de exibição de lista é um modo de exibição de lista móvel. |
ModerationType |
String |
L |
Sim |
Obtém um valor que especifica o tipo de aprovação de conteúdo para o modo de exibição de lista. |
OrderedView |
Boolean |
L |
Sim |
Obtém um valor que especifica se os itens de lista podem ser reordenados no modo de exibição de lista. |
Paged |
Boolean |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica se o modo de exibição de lista é um modo de exibição paginado. |
PersonalView |
Boolean |
L |
Sim |
Obtém um valor que especifica se o modo de exibição de lista é um modo de exibição pessoal. |
ReadOnlyView |
Boolean |
L |
Sim |
Obtém um valor que especifica se o modo de exibição de lista é somente para leitura. |
RequiresClientIntegration |
Boolean |
L |
Sim |
Obtém um valor que especifica se o modo de exibição de lista requer direitos de integração de cliente. |
RowLimit |
Int32 |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica o número máximo de itens de lista a serem exibidos em uma página visual do modo de exibição de lista. |
Scope |
Int32 |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica o escopo para o modo de exibição de lista. Representa um valor ViewScope. DefaultValue = 0, Recursive = 1, RecursiveAll = 2, FilesOnly = 3. |
ServerRelativeUrl |
String |
L |
Sim |
Obtém um valor que especifica a URL relativa do servidor da página do modo de exibição de lista. |
StyleId |
String |
L |
Sim |
Obtém um valor que especifica o identificador do estilo de exibição para o modo de exibição de lista. |
Threaded |
Boolean |
L |
Sim |
Obtém um valor que especifica se o modo de exibição de lista é um modo de exibição. |
Título |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica o nome de exibição do modo de exibição de lista. |
Toolbar |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica a barra de tarefas para o modo de exibição de lista. |
ToolbarTemplateName |
String |
L |
Sim |
Obtém um valor que especifica o nome do modelo para a barra de tarefas que é usada no modo de exibição de lista. |
ViewData |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica os dados de exibição para o modo de exibição de lista. Se não for nulo, o XML deverá estar em conformidade com FieldRefDefinitionViewData, conforme especificado em [MS-WSSCAML]. |
ViewFields |
L |
Não |
Obtém um valor que especifica a coleção de campos no modo de exibição de lista. |
|
ViewJoins |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica as relações que são usadas no modo de exibição de lista. Se não for nulo, o XML deverá estar em conformidade com ListJoinsDefinition, conforme especificado em [MS-WSSCAML]. |
ViewProjectedFields |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica os campos projetados que irão ser utilizados pelo modo de exibição de lista. Se não for nulo, o XML deverá estar em conformidade com ProjectedFieldsDefinitionType, conforme especificado em [MS-WSSCAML]. |
ViewQuery |
String |
De leitura e gravação |
Sim |
Obtém ou define um valor que especifica a consulta usada pelo modo de exibição de lista. Se não for nulo, o XML deverá estar em conformidade com CamlQueryRoot, conforme especificado em [MS-WSSCAML]. |
ViewType |
String |
L |
Sim |
Obtém um valor que especifica o tipo do modo de exibição de lista. Pode ser HTML, GRID, CALENDAR, RECURRENCE, CHART ou GANTT. |
Métodos de View
Método DeleteObject
Exemplos
Método RenderAsHtml
Retorna o modo de exibição de lista como HTML.
Ponto de extremidade |
/renderashtml |
Parâmetros |
Nenhum |
HTTP method |
GET |
Resposta |
Tipo: String |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
/renderashtml
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Representação do OData
O exemplo a seguir representa um recurso View no formato JSON.
{"d":{
"__metadata":{,
"id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
"type":"SP.View"
},
"ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
"Aggregations":null,
"AggregationsStatus":null,
"BaseViewId":"2",
"ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"}, "StringValue":"0x"},
"DefaultView":false,
"DefaultViewForContentType":false,
"EditorModified":false,
"Formats":null,
"Hidden":false,
"HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
"Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
"ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
"IncludeRootFolder":false,
"ViewJoins":null,
"JSLink":"hierarchytaskslist.js",
"ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
"Method":null,
"MobileDefaultView":false,
"MobileView":true,
"ModerationType":null,
"OrderedView":false,
"Paged":true,
"PersonalView":false,
"ViewProjectedFields":null,
"ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
"ReadOnlyView":false,
"RequiresClientIntegration":false,
"RowLimit":100,
"Scope":0,
"ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
"StyleId":null,
"Threaded":false,
"Title":"Late Tasks",
"Toolbar":"",
"ToolbarTemplateName":null,
"ViewType":"HTML",
"ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
}}
Recurso ViewCollection
Representa uma coleção de recursos View.
URI do ponto de extremidade | Métodos | Representação do OData
URI do ponto de extremidade
http://<site url>/_api/web/lists(guid'<list id>')/views
Métodos HTTP com suporte
GET | POST
Exemplos de solicitação
Exemplo de solicitação GET: Obter todos os modos de exibição para uma lista
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Exemplo de solicitação GET: Obter um modo de exibição específico
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode usar o método GetByTitle do recurso ViewCollection para obter um modo de exibição pelo título (que diferencia maiúsculas de minúsculas). Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').
Exemplo de solicitação POST: Criar um modo de exibição
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
?@target='<host web url>'",
method: "POST",
body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'By Status',
'PersonalView': false }",
headers: {
"accept": "application/json;odata=verbose",
"content-type": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
Quando você cria um modo de exibição, o servidor o retorna. Para adicionar, remover ou alterar a ordem dos campos de modo de exibição referente ao novo modo de exibição, use os métodos ViewFieldCollection.
Métodos de ViewCollection
Método GetById
Obtém o modo de exibição de lista com a ID especificada.
Ponto de extremidade |
/getbyid('<view id>') |
Parâmetros |
Tipo: String |
HTTP method |
GET |
Resposta |
Tipo: SP.View |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
/getbyid('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Se preferir, você pode passar apenas a ID do modo de exibição para o recurso ViewCollection. Exemplo: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc').
Método GetByTitle
Obtém o modo de exibição de lista com o título especificado.
Ponto de extremidade |
/getbytitle('<view title>') |
Parâmetros |
Tipo: String |
HTTP method |
GET |
Resposta |
Tipo: SP.View |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
/getbytitle('By Status')
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Representação do OData
O exemplo a seguir representa um recurso ViewCollection no formato JSON.
{"d":{
"results":[{
"__metadata":{
"id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
"type":"SP.View"
},
"ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
"Aggregations":null,
"AggregationsStatus":null,
"BaseViewId":"1",
"ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
"DefaultView":true,
"DefaultViewForContentType":false,
"EditorModified":false,
"Formats":null,
"Hidden":false,
"HtmlSchemaXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData></View>"
"Id":"9824c4ff-14fd-4f24-b481-fa33d90f2d85",
"ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
"IncludeRootFolder":false,
"ViewJoins":null,
"JSLink":"hierarchytaskslist.js",
"ListViewXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
"Method":null,
"MobileDefaultView":true,
"MobileView":true,
"ModerationType":null,
"OrderedView":false,
"Paged":true,
"PersonalView":false,
"ViewProjectedFields":null,
"ViewQuery":null
"ReadOnlyView":false,
"RequiresClientIntegration":false,
"RowLimit":100,
"Scope":0,
"ServerRelativeUrl":"/Lists/Backlog items/AllItems.aspx",
"StyleId":null,
"Threaded":false,
"Title":"All Tasks",
"Toolbar":"",
"ToolbarTemplateName":null,
"ViewType":"HTML",
"ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"}}"
},{
"__metadata":{
"id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
"type":"SP.View"
},
"ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
"Aggregations":null,
"AggregationsStatus":null,
"BaseViewId":"2",
"ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
"DefaultView":false,
"DefaultViewForContentType":false,
"EditorModified":false,
"Formats":null,
"Hidden":false,
"HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
"Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
"ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
"IncludeRootFolder":false,
"ViewJoins":null,
"JSLink":"hierarchytaskslist.js",
"ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
"Method":null,
"MobileDefaultView":false,
"MobileView":true,
"ModerationType":null,
"OrderedView":false,
"Paged":true,
"PersonalView":false,
"ViewProjectedFields":null,
"ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
"ReadOnlyView":false,
"RequiresClientIntegration":false,
"RowLimit":100,
"Scope":0,
"ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
"StyleId":null,
"Threaded":false,
"Title":"Late Tasks",
"Toolbar":"",
"ToolbarTemplateName":null,
"ViewType":"HTML",
"ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
},{
…
}]
}}
Recurso ViewFieldCollection
Representa uma coleção dos campos em um modo de exibição de lista.
URI do ponto de extremidade | Propriedades | Métodos | Representação do OData
URI do ponto de extremidade
http://<site url>/_api/web/lists(guid'<list id>')/views('<view id>')/viewfields
Métodos HTTP com suporte
GET | POST
Exemplos de solicitação
Exemplo de solicitação GET: Obter todos os campos de um modo de exibição
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Propriedades de ViewFieldCollection
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade da propriedade, conforme mostrado no exemplo a seguir.
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields/schemaxml
?@target='<host web url>'",
method: "GET",
headers: { "accept": "application/json; odata=verbose" },
success: successHandler,
error: errorHandler
});
Propriedade |
Tipo |
De leitura/gravação |
Descrição |
|
|---|---|---|---|---|
SchemaXml |
String |
L |
Sim |
Obtém um valor que especifica o esquema XML que representa a coleção. |
Items |
Collection(String) |
L |
Sim |
Especifica o esquema XML da coleção de campos. A propriedade Items é retornada com o recurso, mas não tem um ponto de extremidade endereçável pelo URI. |
Métodos de ViewFieldCollection
AddViewField
MoveViewFieldTo
RemoveAllViewFields
RemoveViewField
Método AddViewField
Adiciona o campo com o nome interno de campo ou nome de exibição especificado à coleção.
Ponto de extremidade |
/addviewfield('<field name>') |
Parâmetros |
Tipo: String |
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
/addviewfield('AssignedTo')
?@target='<host web url>'",
method: "POST",
success: successHandler,
error: errorHandler
});
Método MoveViewFieldTo
Move o campo com o nome interno de campo especificado para a posição especificada na coleção.
Ponto de extremidade |
/moveviewfieldto |
Parâmetros |
|
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
/moveviewfieldto
?@target='<host web url>'",
method: "POST",
body: "{ 'field': 'DueDate', 'index': 0 }",
headers: { "content-type": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
Método RemoveAllViewFields
Remove todos os campos da coleção.
Ponto de extremidade |
/removeallviewfields |
Parâmetros |
Nenhum |
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
/removeallviewfields
?@target='<host web url>'",
method: "POST",
success: successHandler,
error: errorHandler
});
Método RemoveViewField
Remove o campo com o nome interno de campo especificado da coleção.
Ponto de extremidade |
/removeviewfield('<field name>') |
Parâmetros |
Tipo: String |
HTTP method |
POST |
Resposta |
Nenhuma |
Exemplo de solicitação
executor.executeAsync({
url: "<app web url>/_api/SP.AppContextSite(@target)/web
/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
/removeviewfield('AssignedTo')
?@target='<host web url>'",
method: "POST",
success: successHandler,
error: errorHandler
});
Representação do OData
O exemplo a seguir representa um recurso ViewFieldCollection no formato JSON.
{"d":{
"__metadata":{
"id":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
"uri":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
"type":"SP.ViewFieldCollection"
},
"SchemaXml":"<FieldRef Name=\"Checkmark\" /><FieldRef Name=\"Status\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" />",
"Items":{"results":["Checkmark", "Status", "LinkTitle", "DueDate"]}
}}
Recursos adicionais
Realizar operações básicas usando os pontos de extremidade REST do SharePoint 2013
Acessar dados do SharePoint 2013 de suplementos usando a biblioteca de domínio cruzado
Fluxo de autenticação e autorização OAuth para aplicativos hospedados na nuvem
Definir permissões personalizadas em uma lista, usando a interface REST