POST api/Entity/{businessModuleId}/CopyAdvanced/{sourceEntityId}

Copy entity

Request Information

URI Parameters

NameDescriptionTypeAdditional information
businessModuleId

globally unique identifier

Required

sourceEntityId

integer

Required

Body Parameters

WorkPoint365.WebAPI.Model.Controllers.Entity.EntityCopyActionParameter
NameDescriptionTypeAdditional information
DisplacementType

WorkPoint365.WebAPI.Model.Controllers.Entity.TimeDisplacementType

None.

TimedisplacementField

string

None.

AdditionalTimeDisplacementFields

Collection of string

None.

ListOfEntityFields

Dictionary of string [key] and Object [value]

None.

DateTimeFieldsOnEntityLists

Collection of WorkPoint365.WebAPI.Model.Controllers.Entity.EntityTimeDisplacementField

None.

TimeDisplacedFixedTargetDate

string

None.

TimeDisplacementPeriod

WorkPoint365.WebAPI.Model.Controllers.Entity.TimeDisplacementPeriod

None.

TimeDisplacementInterval

integer

None.

Relations

boolean

None.

CopyListsAndDocumentsFromInput

Collection of WorkPoint365.WebAPI.Model.Controllers.Entity.ListSelection

None.

CopyListsAndDocumentAddedInBuilder

Collection of WorkPoint365.WebAPI.Model.Controllers.Entity.ListSelection

None.

StageModel

Object

None.

StartStage

string

None.

Request Formats

application/json, text/json

Sample:
{
  "DisplacementType": 1,
  "TimedisplacementField": "sample string 1",
  "AdditionalTimeDisplacementFields": [
    "sample string 1",
    "sample string 2"
  ],
  "ListOfEntityFields": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "DateTimeFieldsOnEntityLists": [
    {
      "ParentListWebRelativUrl": "sample string 1",
      "InternalFieldName": "sample string 2"
    },
    {
      "ParentListWebRelativUrl": "sample string 1",
      "InternalFieldName": "sample string 2"
    }
  ],
  "TimeDisplacedFixedTargetDate": "sample string 2",
  "TimeDisplacementPeriod": 0,
  "TimeDisplacementInterval": 3,
  "Relations": true,
  "CopyListsAndDocumentsFromInput": [
    {
      "key": "sample string 2",
      "WebRelativName": "sample string 2",
      "Reset": true,
      "Folders": true,
      "Content": true,
      "CopyWithUniquePermissions": true,
      "ExcludedFields": [
        "sample string 1",
        "sample string 2"
      ],
      "TimeDisplacementFields": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "key": "sample string 2",
      "WebRelativName": "sample string 2",
      "Reset": true,
      "Folders": true,
      "Content": true,
      "CopyWithUniquePermissions": true,
      "ExcludedFields": [
        "sample string 1",
        "sample string 2"
      ],
      "TimeDisplacementFields": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "CopyListsAndDocumentAddedInBuilder": [
    {
      "key": "sample string 2",
      "WebRelativName": "sample string 2",
      "Reset": true,
      "Folders": true,
      "Content": true,
      "CopyWithUniquePermissions": true,
      "ExcludedFields": [
        "sample string 1",
        "sample string 2"
      ],
      "TimeDisplacementFields": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "key": "sample string 2",
      "WebRelativName": "sample string 2",
      "Reset": true,
      "Folders": true,
      "Content": true,
      "CopyWithUniquePermissions": true,
      "ExcludedFields": [
        "sample string 1",
        "sample string 2"
      ],
      "TimeDisplacementFields": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "StageModel": {},
  "StartStage": "sample string 6"
}

application/xml, text/xml

Sample:
<EntityCopyActionParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.Controllers.Entity">
  <AdditionalTimeDisplacementFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AdditionalTimeDisplacementFields>
  <CopyListsAndDocumentAddedInBuilder>
    <ListSelection>
      <Content>true</Content>
      <CopyWithUniquePermissions>true</CopyWithUniquePermissions>
      <ExcludedFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ExcludedFields>
      <Folders>true</Folders>
      <Reset>true</Reset>
      <TimeDisplacementFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TimeDisplacementFields>
      <WebRelativName>sample string 2</WebRelativName>
      <key>sample string 2</key>
    </ListSelection>
    <ListSelection>
      <Content>true</Content>
      <CopyWithUniquePermissions>true</CopyWithUniquePermissions>
      <ExcludedFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ExcludedFields>
      <Folders>true</Folders>
      <Reset>true</Reset>
      <TimeDisplacementFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TimeDisplacementFields>
      <WebRelativName>sample string 2</WebRelativName>
      <key>sample string 2</key>
    </ListSelection>
  </CopyListsAndDocumentAddedInBuilder>
  <CopyListsAndDocumentsFromInput>
    <ListSelection>
      <Content>true</Content>
      <CopyWithUniquePermissions>true</CopyWithUniquePermissions>
      <ExcludedFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ExcludedFields>
      <Folders>true</Folders>
      <Reset>true</Reset>
      <TimeDisplacementFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TimeDisplacementFields>
      <WebRelativName>sample string 2</WebRelativName>
      <key>sample string 2</key>
    </ListSelection>
    <ListSelection>
      <Content>true</Content>
      <CopyWithUniquePermissions>true</CopyWithUniquePermissions>
      <ExcludedFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ExcludedFields>
      <Folders>true</Folders>
      <Reset>true</Reset>
      <TimeDisplacementFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TimeDisplacementFields>
      <WebRelativName>sample string 2</WebRelativName>
      <key>sample string 2</key>
    </ListSelection>
  </CopyListsAndDocumentsFromInput>
  <DateTimeFieldsOnEntityLists>
    <EntityTimeDisplacementField>
      <InternalFieldName>sample string 2</InternalFieldName>
      <ParentListWebRelativUrl>sample string 1</ParentListWebRelativUrl>
    </EntityTimeDisplacementField>
    <EntityTimeDisplacementField>
      <InternalFieldName>sample string 2</InternalFieldName>
      <ParentListWebRelativUrl>sample string 1</ParentListWebRelativUrl>
    </EntityTimeDisplacementField>
  </DateTimeFieldsOnEntityLists>
  <DisplacementType>Fixed</DisplacementType>
  <ListOfEntityFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ListOfEntityFields>
  <Relations>true</Relations>
  <StageModel />
  <StartStage>sample string 6</StartStage>
  <TimeDisplacedFixedTargetDate>sample string 2</TimeDisplacedFixedTargetDate>
  <TimeDisplacementInterval>3</TimeDisplacementInterval>
  <TimeDisplacementPeriod>Days</TimeDisplacementPeriod>
  <TimedisplacementField>sample string 1</TimedisplacementField>
</EntityCopyActionParameter>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.