Skip to main content
Get For Date Range

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

DocumentPluginId, MinDate, MaxDate, IncludeEmails

GetForDateRange: Gets a migration summary for documents in the provided date-rage

DocumentPluginId
integer<int32>
MinDate
string<date-time>
MaxDate
string<date-time>
IncludeEmails
boolean

Response

OK

Carrier object for DocumentMigrationItemList. Services for the DocumentMigrationItemList Carrier is available from the DocumentMigration Agent.

NumDocumentsOmitted
integer<int32>

Total amount of documents within the selection criteria, which has been omitted from the migration.

NumDocumentsAlreadyMigrated
integer<int32>

Documents already migrated to the requested documentplugin.

Documents
object[]

List of documents to be migrated.

Associates
object[]

List of associates whose documents will be migrated.