POST api/BusinessModules/{bmId}/QueueSecuritySynchronizationJob

Queue a security synchronization job for a specific business module.

Request Information

URI Parameters

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

Body Parameters

Options object that specifies what should be synchronized by the job

WorkPoint365.WebAPI.Model.QueueSecuritySynchronizationJobModel

Name	Type	Additional information
SynchronizationScope	WorkPoint365.WebAPI.Model.SynchronizationScopeEnum	None.
ViewId	globally unique identifier	None.
CamlQuery	string	None.
RuleScopes	Collection of WorkPoint365.WebAPI.Model.QueueSecuritySynchronizationJobModel+SecuritySettingsRuleScope	None.
SiteCollectionSecurityScopes	Collection of WorkPoint365.WebAPI.Model.QueueSecuritySynchronizationJobModel+SiteCollectionSecurityScope	None.

Request Formats

application/json, text/json

Sample:

{
  "SynchronizationScope": 0,
  "ViewId": "6e352089-92ce-4178-b146-233a636bd1fb",
  "CamlQuery": "sample string 1",
  "RuleScopes": [
    0,
    0
  ],
  "SiteCollectionSecurityScopes": [
    1,
    1
  ]
}

application/xml, text/xml

Sample:

<QueueSecuritySynchronizationJobModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <CamlQuery>sample string 1</CamlQuery>
  <RuleScopes>
    <QueueSecuritySynchronizationJobModel.SecuritySettingsRuleScope>List</QueueSecuritySynchronizationJobModel.SecuritySettingsRuleScope>
    <QueueSecuritySynchronizationJobModel.SecuritySettingsRuleScope>List</QueueSecuritySynchronizationJobModel.SecuritySettingsRuleScope>
  </RuleScopes>
  <SiteCollectionSecurityScopes>
    <QueueSecuritySynchronizationJobModel.SiteCollectionSecurityScope>SiteCollectionAdministrators</QueueSecuritySynchronizationJobModel.SiteCollectionSecurityScope>
    <QueueSecuritySynchronizationJobModel.SiteCollectionSecurityScope>SiteCollectionAdministrators</QueueSecuritySynchronizationJobModel.SiteCollectionSecurityScope>
  </SiteCollectionSecurityScopes>
  <SynchronizationScope>View</SynchronizationScope>
  <ViewId>6e352089-92ce-4178-b146-233a636bd1fb</ViewId>
</QueueSecuritySynchronizationJobModel>

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.