Partager via

Synchroniser les éléments SharePoint à l’aide du service REST

  • Article

Si vous souhaitez synchroniser des éléments entre SharePoint et vos compléments ou services, vous pouvez utiliser la ressource GetListItemChangesSinceToken pour ce faire. Le GetListItemChangesSinceToken, qui fait partie du service REST SharePoint, correspond à l’appel de service web Lists.GetListItemChangesSinceToken.

Envoyez une requête POST dont le corps comprend un objet SP Propriétés de l’objet ChangeLogItemQuery.

La requête renvoie la valeur XML ADO rowset qui inclut les lignes correspondant aux modifications d’élément de liste qui répondent à la requête spécifiée. Pour plus d’informations sur ces propriétés, y compris sur les structures de données des propriétés, les descriptions des éléments CAML et les valeurs de retour, voir Lists.GetListItemChangesSinceToken.

Exemple

POST https://{site_url}/_api/web/Lists/GetByTitle('Announcements')/GetListItemChangesSinceToken`
Authorization: "Bearer " + accessToken
Content-Type: "application/json"
Content-Length: {length of request body as integer}

{
  "d" : {
  "query": {
    "__metadata": {
      "type": "SP.ChangeLogItemQuery"
    },
    "ViewName": "",
    "Query": "
      <Query>
        <Where>
          <Contains>
            <FieldRef Name='Title' />
            <Value Type='Text'>Te</Value>
          </Contains>
        </Where>'
      </Query>,
    "QueryOptions": "
      <QueryOptions>
        <IncludeMandatoryColumns>FALSE</IncludeMandatoryColumns>
        <DateInUtc>False</DateInUtc>
        <IncludePermissions>TRUE</IncludePermissions>
        <IncludeAttachmentUrls>FALSE</IncludeAttachmentUrls>
        <Folder>Shared Documents/Test1</Folder>
      </QueryOptions>',
    "ChangeToken":"1;3;eee4c6d5-f88a-42c4-8ce1-685122984870;634397182229400000;3710",
    "Contains": "
      <Contains>
        <FieldRef Name="Title"/>
        <Value Type="Text">Testing</Value>
      </Contains>"
    }
  }
}

Propriétés de l’objet SP.ChangeLogItemQuery

Propriété Description
ListName Chaîne qui contient le titre ou le GUID de la liste. Lorsque vous interrogez la table UserInfo, la chaîne contient UserInfo. L’utilisation du GUID améliore les performances.
ViewName Chaîne qui contient le GUID de la vue, qui détermine l’affichage à utiliser pour les attributs d’affichage par défaut représentés par les paramètres query, viewFields et rowLimit. Si cet argument n’est pas indiqué, la vue par défaut est affichée.

S’il est défini, la valeur du paramètre query, viewFields ou rowLimit remplace le paramètre équivalent dans l’affichage.

Par exemple, si l’affichage spécifié par le paramètre viewFields est limité à 100 lignes, mais que le paramètre rowLimit a pour valeur 1 000, 1 000 lignes sont renvoyées dans la réponse.
Query Élément Query qui contient la requête et qui détermine les enregistrements renvoyés et l’ordre dans lequel ils le sont.
QueryOptions Fragment de code XML au format suivant qui contient des nœuds distincts pour les différentes propriétés de l’objet SPQuery.
ChangeToken Chaîne qui contient le jeton de modification de la demande.

Pour obtenir une description du format utilisé dans cette chaîne, voir Vue d’ensemble du journal des modifications. Si la valeur null est indiquée, tous les éléments de la liste sont renvoyés.
Contains Élément Contains qui définit un filtre personnalisé pour la requête.

Voir aussi