POST api/Document/CopyDocuments

Copy or move documents

Request Information

URI Parameters

None.

Body Parameters

WorkPoint365.WebAPI.Model.CopyDocumentsModel
NameDescriptionTypeAdditional information
Mode

WorkPoint365.WebAPI.Model.CopyDocumentsModel+CopyMoveOperationType

Required

ListOfSourceDocuments

Collection of Dictionary of Object [key] and Object [value]

None.

TargetBusinessModuleId

globally unique identifier

Required

TargetEntityId

integer

Required

TargetWebRelativListUrl

string

Required

TargetFolderRelativListUrl

string

None.

NameConflict

WorkPoint365.WebAPI.Model.CopyDocumentsModel+MigrationNameConflictBehavior

Required

IgnoreVersionHistory

boolean

None.

ContentTypeId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Mode": "Copy",
  "ListOfSourceDocuments": null,
  "TargetBusinessModuleId": "02d02363-e407-415d-9eef-713a33524e7f",
  "TargetEntityId": 2,
  "TargetWebRelativListUrl": "sample string 3",
  "TargetFolderRelativListUrl": "sample string 4",
  "NameConflict": 0,
  "IgnoreVersionHistory": true,
  "ContentTypeId": "sample string 6"
}

application/xml, text/xml

Sample:
<CopyDocumentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <ContentTypeId>sample string 6</ContentTypeId>
  <IgnoreVersionHistory>true</IgnoreVersionHistory>
  <ListOfSourceDocuments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Mode>Copy</Mode>
  <NameConflict>Fail</NameConflict>
  <TargetBusinessModuleId>02d02363-e407-415d-9eef-713a33524e7f</TargetBusinessModuleId>
  <TargetEntityId>2</TargetEntityId>
  <TargetFolderRelativListUrl>sample string 4</TargetFolderRelativListUrl>
  <TargetWebRelativListUrl>sample string 3</TargetWebRelativListUrl>
</CopyDocumentsModel>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.