POST Agents/DocumentMigration/CreateDefaultDocumentMigrationItemList

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Agents/DocumentMigration/CreateDefaultDocumentMigrationItemList

Loading default values into a new DocumentMigrationItemList.

NsApiSlow threshold: 5000 ms.

Online Restricted: ## The DocumentMigration agent is not available in Online by default. Access must be requested specifically when app is registered. Intended for SuperOffice-internal apps.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: DocumentMigrationItemList

Property Name Type Description
NumDocumentsOmitted int32 Total amount of documents within the selection criteria, which has been omitted from the migration.
NumDocumentsAlreadyMigrated int32 Documents already migrated to the requested documentplugin.
Documents array List of documents to be migrated.
Associates array List of associates whose documents will be migrated.

Sample request

POST /api/v1/Agents/DocumentMigration/CreateDefaultDocumentMigrationItemList
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "NumDocumentsOmitted": 42,
  "NumDocumentsAlreadyMigrated": 1547,
  "Documents": [
    {
      "DocumentId": 220,
      "ContactId": 9,
      "PersonId": 829,
      "SaleId": 74,
      "ProjectId": 77,
      "DocTmplId": 658,
      "AssociateId": 739,
      "UserGroupId": 270,
      "VisibleForId": 611
    }
  ],
  "Associates": [
    {
      "AssociateId": 823,
      "EmailAddress": "john.anderson@acmecorp.com"
    },
    {
      "AssociateId": 824,
      "EmailAddress": "sarah.johnson@acmecorp.com"
    }
  ]
}