POST api/BusinessModules/{bmId}/Entities/{entityId}/QueueMasterSiteSyncJob

Queue a master site synchronization job a specific business module entity.

Request Information

URI Parameters

Name	Description	Type	Additional information
bmId	Business Module Id	globally unique identifier	Required
entityId	Entity Id	integer	Required

Body Parameters

Options object that specifies what should be synchronized by the job

WorkPoint365.WebAPI.Model.QueueMasterSiteEntitySynchronizationModel

Name	Type	Additional information
SynchronizationScope	WorkPoint365.WebAPI.Model.SynchronizationScopeEnum	None.
ViewId	globally unique identifier	None.
CamlQuery	string	None.
SetWelcomePage	boolean	None.
SyncWebParts	boolean	None.
SyncFeatures	boolean	None.
SyncNavigation	boolean	None.
SyncNintexWorkflows	boolean	None.
SyncNintexWorkflowsDeleteFromTargetSite	boolean	None.
SyncTeamSettings	boolean	None.
DeleteAddTeamTabs	boolean	None.
SyncDefaultSiteCollectionSettings	boolean	None.
SyncSiteColumns	boolean	None.
SyncSiteContentTypes	boolean	None.
SyncLanguageResources	boolean	None.
SyncSiteCollectionTermSets	boolean	None.
SyncSiteCollectionFeatures	boolean	None.
SyncSiteCollectionApps	boolean	None.
ListScopes	Collection of WorkPoint365.WebAPI.Model.ListScope	None.

Request Formats

application/json, text/json

Sample:

{
  "SetWelcomePage": true,
  "SyncWebParts": true,
  "SyncFeatures": true,
  "SyncNavigation": true,
  "SyncNintexWorkflows": true,
  "SyncNintexWorkflowsDeleteFromTargetSite": true,
  "SyncTeamSettings": true,
  "DeleteAddTeamTabs": true,
  "SyncDefaultSiteCollectionSettings": true,
  "SyncSiteColumns": true,
  "SyncSiteContentTypes": true,
  "SyncLanguageResources": true,
  "SyncSiteCollectionTermSets": true,
  "SyncSiteCollectionFeatures": true,
  "SyncSiteCollectionApps": true,
  "ListScopes": [
    {
      "WebRelativeUrl": "sample string 1",
      "Fields": true,
      "ContentTypes": true,
      "ItemScope": {
        "Enabled": true,
        "ExcludeItemsWithUniqueRoleAssignments": true,
        "FoldersOnly": true,
        "IncludeVersionHistory": true,
        "ResetToTemplate": true,
        "SetAuthorAndEditor": true
      },
      "Settings": true,
      "Views": true,
      "ReplicateFieldResources": true,
      "ReplicateCTonNoneMngAllowedLists": true,
      "ReplicateViewResources": true
    },
    {
      "WebRelativeUrl": "sample string 1",
      "Fields": true,
      "ContentTypes": true,
      "ItemScope": {
        "Enabled": true,
        "ExcludeItemsWithUniqueRoleAssignments": true,
        "FoldersOnly": true,
        "IncludeVersionHistory": true,
        "ResetToTemplate": true,
        "SetAuthorAndEditor": true
      },
      "Settings": true,
      "Views": true,
      "ReplicateFieldResources": true,
      "ReplicateCTonNoneMngAllowedLists": true,
      "ReplicateViewResources": true
    }
  ],
  "SynchronizationScope": 0,
  "ViewId": "2783cf0a-98c9-4f26-93a8-b3f9a4b7c491",
  "CamlQuery": "sample string 1"
}

application/xml, text/xml

Sample:

<QueueMasterSiteEntitySynchronizationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <CamlQuery>sample string 1</CamlQuery>
  <DeleteAddTeamTabs>true</DeleteAddTeamTabs>
  <ListScopes>
    <ListScope>
      <ContentTypes>true</ContentTypes>
      <Fields>true</Fields>
      <ItemScope>
        <Enabled>true</Enabled>
        <ExcludeItemsWithUniqueRoleAssignments>true</ExcludeItemsWithUniqueRoleAssignments>
        <FoldersOnly>true</FoldersOnly>
        <IncludeVersionHistory>true</IncludeVersionHistory>
        <ResetToTemplate>true</ResetToTemplate>
        <SetAuthorAndEditor>true</SetAuthorAndEditor>
      </ItemScope>
      <ReplicateCTonNoneMngAllowedLists>true</ReplicateCTonNoneMngAllowedLists>
      <ReplicateFieldResources>true</ReplicateFieldResources>
      <ReplicateViewResources>true</ReplicateViewResources>
      <Settings>true</Settings>
      <Views>true</Views>
      <WebRelativeUrl>sample string 1</WebRelativeUrl>
    </ListScope>
    <ListScope>
      <ContentTypes>true</ContentTypes>
      <Fields>true</Fields>
      <ItemScope>
        <Enabled>true</Enabled>
        <ExcludeItemsWithUniqueRoleAssignments>true</ExcludeItemsWithUniqueRoleAssignments>
        <FoldersOnly>true</FoldersOnly>
        <IncludeVersionHistory>true</IncludeVersionHistory>
        <ResetToTemplate>true</ResetToTemplate>
        <SetAuthorAndEditor>true</SetAuthorAndEditor>
      </ItemScope>
      <ReplicateCTonNoneMngAllowedLists>true</ReplicateCTonNoneMngAllowedLists>
      <ReplicateFieldResources>true</ReplicateFieldResources>
      <ReplicateViewResources>true</ReplicateViewResources>
      <Settings>true</Settings>
      <Views>true</Views>
      <WebRelativeUrl>sample string 1</WebRelativeUrl>
    </ListScope>
  </ListScopes>
  <SetWelcomePage>true</SetWelcomePage>
  <SyncDefaultSiteCollectionSettings>true</SyncDefaultSiteCollectionSettings>
  <SyncFeatures>true</SyncFeatures>
  <SyncLanguageResources>true</SyncLanguageResources>
  <SyncNavigation>true</SyncNavigation>
  <SyncNintexWorkflows>true</SyncNintexWorkflows>
  <SyncNintexWorkflowsDeleteFromTargetSite>true</SyncNintexWorkflowsDeleteFromTargetSite>
  <SyncSiteCollectionApps>true</SyncSiteCollectionApps>
  <SyncSiteCollectionFeatures>true</SyncSiteCollectionFeatures>
  <SyncSiteCollectionTermSets>true</SyncSiteCollectionTermSets>
  <SyncSiteColumns>true</SyncSiteColumns>
  <SyncSiteContentTypes>true</SyncSiteContentTypes>
  <SyncTeamSettings>true</SyncTeamSettings>
  <SyncWebParts>true</SyncWebParts>
  <SynchronizationScope>View</SynchronizationScope>
  <ViewId>2783cf0a-98c9-4f26-93a8-b3f9a4b7c491</ViewId>
</QueueMasterSiteEntitySynchronizationModel>

Response Information

Resource Description

The Id of the queued job.

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.