id stringlengths 14 16 | text stringlengths 2 3.14k | source stringlengths 45 175 |
|---|---|---|
906a303135ff-7 | \":[{\"id\":\"606c56de-9e71-42ef-8ec6-f0bbf351d673\",\"kind\":\"dictionaryFeature\",\"name\":\"start\",\"active\":true,\"nGrams\":[\"BETWEEN:\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"334e6df5-e076-40db-a47b-f11ceec7af9a\",\"kind\":\"dictionaryFeature\",\"name\":... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbyuniqueid-method |
906a303135ff-8 | Date\":[{\"id\":\"fabe1ed3-07af-4dc6-852d-fe9521c64801\",\"kind\":\"dictionaryFeature\",\"name\":\"dated\",\"active\":true,\"nGrams\":[\"dated\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"983da7b8-51d7-4a85-9644-007b488fce0b\",\"kind\":\"dictionaryFeature\",\"name\"... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbyuniqueid-method |
906a303135ff-9 | "ID": 16,
"LastTrained": "2021-01-27T03:04:00Z",
"ListID": "f1e13676-8595-4c22-9ca2-c0a4076686ca",
"ModelSettings": null,
"ModelType": 2,
"Modified": "2021-01-27T03:05:04Z",
"ModifiedBy": "i:0#.f|membership|kevinche@contoso.com",
"ObjectId": "01ZBWEM5E54ZCXN6ZBERFKC6U336T4WY64",
"Publica... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbyuniqueid-method |
906a303135ff-10 | "PublicationType": 0,
"Schemas": "{\"Extractors\":{\"Contract Name\":{\"concepts\":{\"841d0dcf-7f1d-4a39-931c-53923d10c346\":{\"name\":\"Contract Name\"}},\"relationships\":[]},\"Client \":{\"concepts\":{\"8b8490d0-9a09-4c16-bcff-59ce62e05c28\":{\"name\":\"Client \"}},\"relationships\":[]},\"Contract Date\":{\"conc... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbyuniqueid-method |
906a303135ff-11 | See also
Syntex document understanding model REST API | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbyuniqueid-method |
831ec309a47c-0 | Creates a model and its associated content type. Note that this only creates the model. It will still need to be trained in the content center (see example ).
HTTP request
POST /_api/machinelearning/models HTTP/1.1
URI Parameters
None
Request headers
Header
Value
Accept
application/jso... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-createmodel-method |
831ec309a47c-1 | "ContentTypeName": "Contoso Contract"
}
Sample response
Status code: 201
See also
Syntex document understanding model REST API | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-createmodel-method |
a5738461dea6-0 | You can use the SharePoint REST interface to create an unstructured document processing model, apply or remove the model to one or more libraries, and obtain or update information about the model.
The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/syntex-model-rest-api |
a5738461dea6-1 | Scenarios
Note the following scenario examples that aren't intuitive from the method name. For more information, see each article.
The create model method only creates the model object and its associated content type. You'll need to first train the model in the content center before it can be applied to a library. ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/syntex-model-rest-api |
b2abdac24ae6-0 | Using the Migration API requires a temporary storage container in Azure. This Azure container is already only openable by someone having a SAS key access to the container. The Goal of this feature is to allow to pass Encrypted content at rest to the API meaning that even if a malicious user has access to the Container ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-encryption |
b2abdac24ae6-1 | The new parameter is: EncryptionOption
For now, it only supports receiving an AES256CBC Encryption Key.
Example:
public Guid CreateMigrationJobEncrypted(
Guid gWebId,
string azureContainerSourceUri,
string azureContainerManifestUri,
string azureQueueReportUri,
Encrypti... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-encryption |
6dc105d5b3ef-0 | Microsoft’s Migration API requires the use of an Azure container for temporary storage. To simplify the process, you are now provided with a default container while using the migration API. To use the provided container you will need to decorate your traffic correctly to avoid throttling. If you choose, you can still... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-azure-container-and-queue |
6dc105d5b3ef-1 | Uri MetadataContainer Uri
byte[] EncryptionKey
Getting Queue
public SPProvisionedMigrationQueueInfo ProvisionMigrationQueue()
This method will return a string containing the SAS token for accessing the Azure queue.
The queue can be reused across multiple migration jobs so this call should not be that frequen... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-azure-container-and-queue |
a05bc6c5162d-0 | Overview
The goal of the new Migration Asynchronous Metadata Read (AMR) API is to reduce the number of calls, reduce throttling, and improve overall migration performance for our customers. Instead of calling thousands of calls to query information from SPO, the new Migration Asynchronous Metadata Read can return the... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-1 | Permission settings function calls are made to get user permission information.
SharePoint Migration Export (Asynchronous Metadata Read) API
The SharePoint Migration Export (Asynchronous Metadata Read) API aims to reduce the calls in areas: incremental migration, after migration verification and permission sett... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-2 | Input Parameters
URL
The full path URL lets your migration tool to specify the root URL path of the SharePoint list, files/folder document library to be read. By default, the server-side code will read and return all the metadata of files, folders, and root objects including subfolders and their children content. ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-3 | readOptions Flag
The read asynchronous function will include the SPAsyncReadOptions structure, which covers the optional flags to allow the user to specify version and security setting on the site level more is described below.
IncludeVersions{ get; set; }
If set, this indicates all the files and list item versi... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-4 | The use case for this function: The ISV can issue a default read to retrieve the top-level items and then issue multiple CreateSPAsyncReadJob to read back all the sub folder content in parallel to improve throughput.
public bool IncludeExtendedMetadata { get; set; }
This flag indicates whether to return the ext... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-5 | encryptionOption
This is an optional parameter. If it is specified, the AES256CBCKey is used to encrypt output files and queue messages. Otherwise, there is no encryption.
For more information, see EncryptionOption Class .
azureContainerManifestUri
The valid URL including SAS token for accessing the Azure Blob... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-6 | Manifest Output
After the asyncMigrationRead function prepares execution, the final manifest will be placed in the container specified, under a folder named JobId . The manifest export package structure will be like the createMigration Import Package structure. The general output structure is summarized in table... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-7 | Requirements.XML
DeploymentRequirements Schema
"Provides validation for the Requirements.xml file exported into the content migration package. Requirements.xml maintains list of deployment requirements in the form of installation requirements on the migration target, such as feature definitions, template versions,... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-8 | using (Stream stmTemp = new MemoryStream())
{
// Download current manifest file
blob.DownloadToStream(stmTemp);
// Get IV and decrypt the content into output dir
byte[] IV = Convert.FromBase64String(blob.Metadata[“IV”]); | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-9 | using (Stream targetStream = System.IO.File.Open(outputFileFullPath, FileMode.Append))
{
using (Aes alg = new AesCryptoServiceProvider())
{
stmTemp.Seek(0, SeekOrigin.Begin);
using (CryptoStream csDecrypt = new CryptoStream(
stmTemp,
... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-10 | {"Time", “2019-09-03T19:11:33.903”},
{"ManifestFileName", “f8d7d577-676e-47ce-ab69-ae7803979883/ExportSettings.xml”}
EncryptionKey
public byte[] EncryptionKey { get; set; }
It returns the AES256CBC encryption key used to decrypt the message in azureManifest container and azureReport Queue.
Output parame... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-11 | SharePoint Migration Export (Asynchronous Metadata Read) API Example
Scenario: Large file share (> 1 million) with nested files/folders
Suggestion:
Issue CreateSPAsyncReadJob
URL = root URL (for example, www.contoso.com/my-resource-document )
Optional Flag: IncludeDirectDescendantsOnly(true)
For eac... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-12 | # Get the Doclib root folder
$rootFolder = $web.GetFolder($list.Rootfolder.ServerRelativeUrl)
# You can call 1 AMR job here, to get metadata of the direct children of the root folder only
CreateAMRJob($rootFolder) | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-13 | # Create parallel AMR jobs for the direct level subfolders
Foreach ($folder in $rootFolder.SubFolders)
{
// Create 1 AMR job per folder tree
CreateAMRJob($folder)
}
The ISV can optimize the recursive highlight part by leveraging the $ folder.item["SMTotalFileCount"] that will return the cumulative file count in ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
a05bc6c5162d-14 | Performance Expectation
The preliminary performance test provides a rough estimate of more than 400 items per second throughput for every 250K of objects read. We have seen over 700 items per second throughput in a testing environment. However, this is highly dependent on the number of items that are being read plus... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/export-amr-api |
097313128aef-0 | The Migration API supports the ability to migrate web parts to SharePoint Online using the PRIME package by calling CSOM/REST/SOAP WS to get web part data and properties to build the PRIME package.
An advantage in using the Migration API for your web part migration is the ability to migrate your web parts in one call... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-1 | <xs:element name="WebParts" type="SPWebPartCollection" minOccurs="0" maxOccurs="1" />
<xs:element name="Links" type="SPLinkCollection" minOccurs="0" maxOccurs="1" />
<xs:element name="EventReceivers" type="SPEventReceiverDefinitionCollection" minOccurs="0" maxOccurs="1" />
<xs:element name="VersionEvents" t... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-2 | <!-- SPWebPartCollection definition -->
<xs:complexType name="SPWebPartCollection">
<xs:sequence>
<xs:element name="WebPart" type="SPWebPart" minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType> | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-3 | <!-- SPWebPart definition -->
<xs:complexType name="SPWebPart">
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="35">
<xs:element name="Script" minOccurs="0" maxOccurs="1" />
<xs:element name="PagedRowset" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="PagedClientCallbackRowset" minOc... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-4 | <xs:element name="ViewBody" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="ViewEmpty" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="ViewFooter" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="ViewHeader" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="ViewB... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-5 | <xs:element name="Method" minOccurs="0" maxOccurs="1" />
<xs:element name="WebParts" minOccurs="0" maxOccurs="1" />
<xs:element name="InlineEdit" minOccurs="0" maxOccurs="1" />
<xs:element name="Joins" minOccurs="0" maxOccurs="1" />
<xs:element name="ProjectedFields" minOccurs="0" maxOccurs="1" ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-6 | <xs:attribute name="Name" type="Guid" use="required" />
<xs:attribute name="ListId" type="Guid" use="optional" />
<xs:attribute name="ListRootFolderUrl" type="xs:string" use="optional" />
<xs:attribute name="Type" type="xs:string" use="optional" />
<xs:attribute name="UserId" type="xs:int" use="optional" />
<... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-7 | <xs:attribute name="WebPartIdProperty" type="xs:string" use="optional" />
<xs:attribute name="ContentTypeId" type="xs:string" use="optional" /> | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-8 | <!-- For files (major [default] or minor) -->
<xs:attribute name="Level" type="xs:string" use="optional" /> | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-9 | <!-- Flags -->
<xs:attribute name="Flags" type="xs:string" use="optional" />
<xs:attribute name="Scope" type="xs:string" use="optional" />
<xs:attribute name="Hidden" type="xs:boolean" use="optional" />
<xs:attribute name="Threaded" type="xs:boolean" use="optional" />
<xs:attribute name="ReadOnly" type="xs:bo... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-10 | XsltListViewWebPart
ContentEditorWebPart
ContentByQueryWebPart
SiteFeedWebPart
ScriptEditorWebPart
ContactFieldControl
SearchBoxScriptWebPart
PageViewerWebPart
ProfileBrowser
UserTasksWebPart
SocialCommentWebPart
SilverlightWebPart
RSSAggregatorWebPart
SummaryLinkWebPart
TableOfContentsWebPa... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-11 | <Title>Content Editor</Title>
<FrameType>Default</FrameType>
<Description>Allows authors to enter rich text content.</Description>
<IsIncluded>true</IsIncluded>
<ZoneID>wpz</ZoneID>
<PartOrder>0</PartOrder>
<FrameState>Normal</FrameState>
<Height />
<Width />
<AllowRemove>true</AllowRemove>
<AllowZo... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-12 | <Content xmlns="http://schemas.microsoft.com/WebPart/v2/ContentEditor" />
<PartStorage xmlns="http://schemas.microsoft.com/WebPart/v2/ContentEditor" />
</WebPart>
Sample Web Part Properties v3 XmlNode Element
<webPart xmlns="http://schemas.microsoft.com/WebPart/v3">
<metaData>
<type name="Microsoft.SharePo... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-13 | <property name="EnableOriginalValue" type="bool">False</property>
<property name="Direction" type="direction">NotSet</property>
<property name="ServerRender" type="bool">False</property>
<property name=" ViewFlags " type="Microsoft.SharePoint.SPViewFlags, Microsoft.SharePoint, Version=15.0.0.0, Cultur... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-14 | <property name="AllowMinimize" type="bool">True</property>
<property name="CacheXslTimeOut" type="int">86400</property>
<property name="ChromeType" type="chrometype">Default</property>
<property name="Xsl" type="string" null="true" />
<property name="JSLink" type="string" null="true" />
<p... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-15 | <property name="InplaceSearchEnabled" type="bool">False</property>
<property name="WebId" type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">00000000-0000-0000-0000-000000000000</property>
<property name="Height" type="string" />
<property name="GhostedXslL... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-16 | <property name="IsClientRender" type="bool">False</property>
<property name="XmlDefinition" type="string"><View Name="{2B37E456-6FD3-4708-AC83-5D7B0D13E9B4}" Type="HTML" Hidden="TRUE" OrderedView="TRUE" DisplayName="" Url="/SitePages/TestPage.aspx" Level="1" BaseViewID="3" ContentTypeID="0x" ><Query>&... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-17 | <property name="AllowHide" type="bool">True</property>
<property name="ParameterBindings" type="string"><ParameterBinding Name="dvt_sortdir" Location="Postback;Connection" /><ParameterBinding Name="dvt_sortfield" Location="Postback;Connection" /><ParameterBinding Name="dvt_startposition" Location="... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
097313128aef-18 | <property name="XslLink" type="string" null="true" />
<property name="SelectParameters" type="string" />
</properties>
</data>
</webPart>
Sample Web Part Connection XmlNode Element
<WebPartPages:SPWebPartConnection ConsumerConnectionPointID="DFWP Filter Consumer ID" ConsumerID="g_bcca2ac1_f0f1_4640_af3... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migrate-webparts-with-migrationapi |
22b4c4c18b56-0 | Implementation
As documented in the Migration PRIME API, apply sharing metadata by using item references . The older method of using the Shared With column should not be used any further.
For an item that is shared with a user, add the SharedWithEvents block within its ListItem block. The SharedWithEvents ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-shared |
22b4c4c18b56-1 | Best Practices
The basics
For each file or folder that was shared with a user in the source, create an item reference for that item in the recipient’s OneDrive. Every item reference created will appear in the user’s Shared with Me view in OneDrive. Remember to give the user permission to access the item as well. ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-shared |
22b4c4c18b56-2 | Anonymous sharing links
Do not migrate anonymous sharing links from the source; this is not useful as it’s not possible to know which users used that link in the source. Users should evaluate whether anonymous links are still needed and create new ones on the destination if so.
Sharing with external users
Before ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-shared |
22b4c4c18b56-3 | Using PRIME, content can be migrated by using SPFile/SPFolder objects with a document library followed by SPListItem objects that reference the imported File/Folder objects. During the ListItem import, the “Shared With” references data can be imported, and then the security can be applied afterward within the same migr... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-shared |
8674e9551d18-0 | Transcripts of video files, like those in Teams meeting recordings, are stored in a format similar to a zip file. If you are migrating videos from one source to another, you must use a new flag to ensure the entire zip file is migrated to the destination. Otherwise, you will inadvertently leave behind the alternate con... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-video-transcripts |
8674e9551d18-1 | Note: In the example above, "1048576" corresponds to the integer value of enum SPOpenBinaryOptions.GetAsZipWithAltStreamsIfAvailable .
Step 3: Import the file with alternate content streams
Use the Migration API to import the zip formatted stream for a file with alternate content streams to SPO. The main steps inv... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-video-transcripts |
ba12daf7cfd3-0 | Sensitivity labels cannot be applied to files and folders using the SharePoint Migration API. If you want to have sensitivity labels applied to your content being migrated to Microsoft 365, we recommend using the Microsoft Information Protection SDK. There currently isn't a parameter in the API to apply sensitivity l... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/sp-migration-api-and-sensitivity-labels |
b2a7a082fbf1-0 | When bringing OneNote notebooks into SharePoint Online (SPO) from outside the service, you are required to convert the file. OneNote files need to be located within a correctly tagged NoteBook folder before the OneNote content is accessible via the modern APIs.
There is now a OneNote converting service in SPO that ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/onenote-migration-service |
67636bc33eeb-0 | You need to be aware of three key numbers as you plan your migration to OneDrive or SharePoint especially when you have a hierarchy of deeply nested folders. They are: (1) the number of SharePoint unique permission scopes, (2) the number of role assignments, and (3) the total number of items in a list or library.
Per... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-perm-guidance |
67636bc33eeb-1 | Item limits
When a library (or list) contains more than 100,000 items (files and folders or list items), you can't break permissions inheritance on the list itself. There's a limit of 100,000 items that can be updated or removed as a part of creating a new SharePoint security scope.
If you're migrating a structure... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-perm-guidance |
67636bc33eeb-2 | The first option is to restructure your source layout.
For example, divide a single folder of 250,000 items into four folders at the root so each folder has less than 100,000 items. There's still "room to grow", presuming users will continue to add content and make changes here.
Make sure that there are no more t... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-perm-guidance |
67636bc33eeb-3 | Other sharing/permission-related considerations
The REST share link or any other permission-modifying function won't take effect if you attempt to update the permission on a file that is checked out by a user.
Finally, if a SharePoint site or OneDrive location is being actively used during migration, the existing per... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-perm-guidance |
56af48a33c62-0 | This document guides ISVs in delivering a fast and reliable migration experience to customers. It contains the latest Microsoft migration practices and concerns or questions raised by ISVs.
Use app-based authentication
There are different usage patterns between end user traffic and an application doing background a... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-isv-guidance |
56af48a33c62-1 | For migration tool that relies on end user signed in and presence, delegated permission is recommended.
For service-based migration tool that run without a signed-in user present such as app that runs as background service, application permission is recommended.
Number of App IDs
Questions have been raised by ISV... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-isv-guidance |
56af48a33c62-2 | Switch to the Microsoft Graph API
If a feature is not supported by the migration API, we recommend that you use the Graph API. If the Graph API does not support the needed migration feature, then use CSOM. However, using CSOM increases the likelihood of being throttled.
Graph Guidance: Best practices for discove... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-isv-guidance |
56af48a33c62-3 | Best practices for improving SharePoint and OneDrive migration performance .
Escalation and throttling
The primary reason speed is impacted, and throttling occurs, is due to the load that gets generated by calling CSOM and REST APIs. As a result of this load, throttling rules fire that impact the speed, reliabili... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-isv-guidance |
fbd90d199b97-0 | Check here to see what features or updates have been added to the Migration API. Here's a summary of what's included.
New: Speed up small file migration
The migration package includes multiple files, which are each uploaded/downloaded individually. If you have a large number of small-sized files, migration speed dr... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-whats-new |
d208d6a66bd3-0 | Important
SharePoint & OneDrive Copy and Move API replaces the CreateCopyJob API. The CreateCopyJob API has been deprecated.
The following API is based on the use of the SharePoint Client Side Object Model (CSOM). We recommend using NuGet packages when you reference CSOM in your solution.
You can find the la... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/spod-copy-move-api |
d208d6a66bd3-1 | public bool AllowSmallerVersionLimitOnDestination { get; set; }
This allows the move to take place if the target file has older version. By default it’s disallowed to prevent data loss.
public SPMigrationNameConflictBehavior NameConflictBehavior { get; set; }
If a name conflict occurs at the target site, the de... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/spod-copy-move-api |
d208d6a66bd3-2 | Output
Output parameter
Description
JobID/GUID
Return a unique Job ID associated with this asynchronous read
SourceListItemUniqueIds
Return the source
JobQueueUri
URL for accessing Azure queue used for returning notification of copy and move process
EncryptionKey
AES256CBC ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/spod-copy-move-api |
a434c9d01b81-0 | This documentation will introduce some APIs which related to SharePoint Add-ins. They could help to have a clear view
and better management of the Add-ins in tenant level, including these:
Get available Add-ins in sites
Get Add-in permissions in site collections
Get tenant ACS service principals
Get Add-in pr... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-1 | Name
Type
Description
addins
SPAddinInstanceInfo[]
Available Add-in instance object.
errorsWithServerRelativeUrl
SPErrorWithServerRelativeUrl[]
Server relative urls that failed to get available add-ins and corresponding reasons.
SPAddinInstanceInfo
Name
Type
Description
... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-2 | appWebFullUrl
string
The full url of the app web. The SharePoint components are generally in a special child web of the host web called the app web. The app web will be created during install the add-in.
appWebId
Guid
Id of the app web.
appWebName
string
Name of the app web.
installedBy
... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-3 | tenantAppData
string
After the Add-in installed in the tenant app catalog site. It could enable tenant level usage. This data indicates the conditions how to filter the sites. If this field is not empty, it means this Add-in installed on tenant app catalog site, deployed to tenant level, and current site matches th... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-4 | Description
serverRelativeUrl
string
The server relative url of the site collection. It will return site collection scope permissions of the given site collection.
appIdentifiers
string[]
The identifier list of the Add-ins.
Responses
Name
Type
Description
addinPermi... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-5 | Type
Description
feature
string
The feature name of the permissions, it should be one of these: Taxonomy Social ProjectServer Search BcsConnection Content
scope
string
The scope of the permission.
right
string
The right of the permission.
id
Guid
The id of th... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-6 | The identifier list of the Add-in.
errorMessage
string
The error message why fetch the Add-in permission failed.
Get tenant ACS service principals
This API takes the app id list as input, it will filter the ones that present ACS service principals.
For more information, see Register SharePoint Add-... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-7 | Get Add-in principals in site collections
This API takes the site collections' server relative url as input, it will return the Add-in principals that have permissions in given sites.
This API needs the app to have at least Sites.Read.All permission.
HTTP request
POST {adminSiteUrl}/_api/web/GetAddinPrincipalsH... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-8 | Uninstall Add-ins
This API will trigger an async job to uninstall the Add-in. If the job triggered successfully, the job id will be returned.
This API needs the app to have Sites.FullControl.All permission.
HTTP request
POST {adminSiteUrl}/_api/web/UninstallAddins
Request body
Name
Required
Type ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-9 | string
The site's server relative url.
uninstallJobId
Guid
The triggered uninstall job id.
SPFailToTriggerUninstallAddinJobResponse
Name
Type
Description
appInstanceId
Guid
The instance id of the Add-in.
serverRelativeUrl
string
The site's server relative url.
... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
a434c9d01b81-10 | jobId
Guid
The uninstall job id.
siteId
Guid
The site collection id.
appInstanceId
Guid
The id of the app instance.
errorDetails
SPUninstallAddinErrorDetail[]
The error details for the job ends with failure.
SPUninstallAddinErrorDetail
Name
Type
Description
... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/addin-management-apis |
f7231ab2cc37-0 | Retention labels let you apply retention settings for governance control at the item level, and are part of the Microsoft Purview compliance solutions. Learn more about retention labels.
Retention labels may classify contents as records, which place restrictions on what actions are allowed or blocked. Learn more ab... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/csom-methods-for-applying-retention-labels |
f7231ab2cc37-1 | The following methods are also available, but are no longer updated and may be subject to deprecation in the future. If you are using these methods, we strongly recommend use of the SetComplianceTagOnBulkItems method instead.
SetComplianceTag
SetComplianceTagWithExplicitMetaInfo
SetComplianceTagWithExplicitMeta... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/csom-methods-for-applying-retention-labels |
1eff388c5618-0 | ALM APIs provide simple APIs to manage deployment of your SharePoint Framework solutions and add-ins across your tenant. ALM APIs support the following capabilities:
Add SharePoint Framework solution or SharePoint Add-in to tenant or site collection app catalog.
Remove SharePoint Framework solution or SharePoint ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-1 | Options for working with ALM APIs
ALM APIs are natively provided by using REST APIs, but there are additional client-side object model (CSOM) extensions, PowerShell cmdlets, and the cross-platform CLI for Microsoft 365 available through SharePoint PnP Community channels.
SharePoint REST API
The ALM APIs are nativ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-2 | // ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-3 | using (var context = new ClientContext(webURL)) {
context.Credentials = new SharePointOnlineCredentials(username, securePassword);
var appManager = new AppManager(context);
// execute PnP CSOM ALM command
}
In all PnP Core methods, it's assumed the request targets the tenant app catalog in the tenant you conne... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-4 | Learn more here: CLI for Microsoft 365
Note
The CLI for Microsoft 365 is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
Add solution package
First add an app package ( *.sppkg or *.app ) to an app catalog in order... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-5 | // read file
var filePath = "c:\path\to\file\sharepoint-solution-package.sppkg";
// get an instance of the PnP CSOM's AppManager as shown above
var result = appManager.Add(filePath);
Add-PnPApp -Path ./sharepoint-solution-package.sppkg
Refer to the PnP PowerShell documentation for complete details and ex... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-6 | m365 spo app deploy --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx
Refer to the CLI for Microsoft 365 documentation for complete details and examples on this command.
Retract solution packages
This is the inverse of the deploy step above. Once retracted, the solution can't be installed in sites.
Sha... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-7 | m365 spo app retract --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx
Refer to the CLI for Microsoft 365 documentation for complete details and examples on this command.
Remove solution packages
This is the inverse of the add step above. One removed from the app catalog, the solution can't be deployed.
... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-8 | Note
If the Retract operation is not performed before the Remove operation, the solution is automatically retracted.
List available packages
This operation will return a list of all available SharePoint Framework solutions or add-ins in the app catalog.
SharePoint REST API
PnP CSOM
PnP Power... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-9 | var allAppPackages = appManager.GetAvailable();
Get-PnPApp
Refer to the PnP PowerShell documentation for complete details and examples on this cmdlet.
m365 spo app list
Refer to the CLI for Microsoft 365 documentation for complete details and examples on this command.
Get a specif... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-10 | m365 spo app get --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx
Refer to the CLI for Microsoft 365 documentation for complete details and examples on this command.
Install solution package in a site
Install a solution package with a specific identifier from the app catalog to the site based on URL context.
... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-11 | m365 spo app install --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx --siteUrl <url>
Refer to the CLI for Microsoft 365 documentation for complete details and examples on this command.
Upgrade installed solution packages
Upgrade a solution package from the site to a newer version available in the app catalog. ... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-12 | m365 spo app upgrade --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx --siteUrl <url>
Refer to the CLI for Microsoft 365 documentation for complete details and examples on this command.
Uninstall solution packages from a site
This action is the inverse of the install command above.
Note
When you use the... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
1eff388c5618-13 | m365 spo app uninstall --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx --siteUrl <url>
Refer to the CLI for Microsoft 365 documentation for complete details and examples on this command.
Synchronize a solution to the Microsoft Teams app catalog
This action requires that you refer the list item ID of the solu... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins |
4a88613cc26b-0 | If you are looking for the legacy SharePoint REST API documentation, see Complete basic operations using SharePoint REST endpoints .
For SharePoint Online, innovation using a REST API against SharePoint is driven via the Microsoft Graph REST API's. In scenarios where solutions already have access tokens available to... | https://learn.microsoft.com/en-us/sharepoint/dev/apis/sharepoint-rest-graph |
fac6ccff05e8-0 | This article describes how you can batch queries and operations against the REST/OData API of Microsoft SharePoint Online (and on-premises SharePoint 2016 and later) and the Files and folders subset of the Office 365 REST APIs. With this technique, you can improve the performance of your add-in by combining many oper... | https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis |
fac6ccff05e8-1 | Important
SharePoint and Office 365 APIs aren't transactional and don't support "all or nothing" functionality for ChangeSets that have more than one operation within them. If any of the child operations fails, the others still complete and aren't rolled back.
Code samples
Samples of code that uses the $batch ... | https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis |
fac6ccff05e8-2 | --batch_e3b6819b-13c3-43bb-85b2-24b14122fed1
Content-Type: application/http
Content-Transfer-Encoding: binary
GET https://fabrikam.sharepoint.com/_api/Web/lists/getbytitle('Composed%20Looks')/items?$select=Title HTTP/1.1
--batch_e3b6819b-13c3-43bb-85b2-24b14122fed1
Content-Type: application/http
Content-Transfer-Enco... | https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis |
fac6ccff05e8-3 | --changeset_efb6b37c-a5cd-45cb-8f5f-4d648006e65d
Content-Type: application/http
Content-Transfer-Encoding: binary
DELETE https://fabrikam.sharepoint.com/_api/Web/lists/getbytitle('OldList') HTTP/1.1
If-Match: "1"
--changeset_efb6b37c-a5cd-45cb-8f5f-4d648006e65d--
--batch_7ba8d60b-efce-4a2f-b719-60c27cc0e70e
Content-T... | https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis |
f657ac922a10-0 | SharePoint sites, lists, and list items are types of SecurableObject . By default, a securable object inherits the permissions of its parent. To set custom permissions for an object, you need to break its inheritance so that it stops inheriting permissions from its parent, and then define new permissions by adding or ... | https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/set-custom-permissions-on-a-list-by-using-the-rest-interface |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.