Skip to main content

BulkJobCreate

Struct BulkJobCreate 

Source
pub struct BulkJobCreate {
    pub action_context: Option<BulkJobCreateActionContext>,
    pub domain_object_identifiers: Vec<Value>,
    pub job_data: Value,
    pub extra: Map<String, Value>,
}
Expand description

Request body for permission previews and queued bulk operations. The domainType and jobKey URL parameters determine the required jobData schema; use the exact mapping below. Send {} for operations without additional data. Target identifiers retain their request order and duplicates. Built-in bulk jobs cast target identifiers to integers; action-based operations expect integer identifiers.

Built-in bulk jobs:

domainTypejobKeyjobData schema
groupaddParentGroupBulkGroupAddParentGroupUpdate
groupaddTagBulkTagCreate
groupdeleteBulkEmptyData
groupdelTagBulkGroupDelTagUpdate
groupsetAgeGroupsBulkGroupAgeGroupsUpdate
groupsetCampusBulkGroupSetCampusUpdate
groupsetGroupCategoryBulkGroupSetGroupCategoryUpdate
groupsetInformLeaderBulkGroupSetInformLeaderUpdate
groupsetMaxMembersBulkGroupSetMaxMembersUpdate
groupsetMeetingTimeBulkGroupMeetingTimeUpdate
groupsetShowInMemberStatisticBulkGroupSetShowInMemberStatisticUpdate
groupsetSignUpOpenBulkGroupSetSignUpOpenUpdate
groupsetStatusBulkGroupStatusUpdate
groupsetTargetGroupBulkGroupSetTargetGroupUpdate
groupsetVisibilityBulkGroupVisibilityUpdate
groupsetWeekdayBulkGroupWeekdayUpdate
groupsetWeeklyMeetingBulkGroupSetWeeklyMeetingUpdate
personaddPersonAuthBulkPersonAddPersonAuthUpdate
personaddDepartmentBulkPersonAddDepartmentUpdate
personaddPersonTagBulkTagCreate
personaddToGroupBulkPersonMembershipCreate
personarchivePersonBulkEmptyData
personchangeCampusBulkPersonChangeCampusUpdate
personchangeFamilyStatusBulkPersonChangeFamilyStatusUpdate
personchangeGroupRoleAndStatusBulkPersonMembershipUpdate
personchangeNationalityBulkPersonChangeNationalityUpdate
personchangeSexBulkPersonChangeSexUpdate
personchangeStatusBulkPersonChangeStatusUpdate
persondeleteDepartmentBulkPersonDeleteDepartmentUpdate
persondeleteFromGroupBulkPersonDeleteFromGroupUpdate
persondeletePersonBulkEmptyData
persondelPersonTagBulkPersonDelPersonTagUpdate
personforceTwoFactorBulkEmptyData
personinvitePersonBulkEmptyData
personchangeGroupMemberFieldBulkPersonMembershipFieldUpdate
persondeactivateForceTwoFactorBulkEmptyData
personundoArchivePersonBulkEmptyData
eventaddPersonToServiceBulkEventServiceAssignmentCreate
eventdeclineEventBulkEventDeclineUpdate

Actions (discoverable through POST /actions):

domainTypejobKeyjobData schema
group_membershipadd-member-to-groupBulkMembershipActionCreate
group_membershiparchive-memberBulkEmptyData
group_membershipchange-member-status-active-requestedBulkEmptyData
group_membershipchange-member-status-active-to_deleteBulkEmptyData
group_membershipchange-member-status-requested-activeBulkEmptyData
group_membershipchange-member-status-requested-to_deleteBulkEmptyData
group_membershipchange-member-status-requested-waitingBulkEmptyData
group_membershipchange-member-status-to_delete-activeBulkEmptyData
group_membershipchange-member-status-to_delete-requestedBulkEmptyData
group_membershipchange-member-status-waiting-activeBulkEmptyData
group_membershipchange-member-status-waiting-requestedBulkEmptyData
group_membershipchange-member-status-waiting-to_deleteBulkEmptyData
group_membershipcreate-follow-upBulkFollowUpActionCreate
group_membershipedit-group-membershipBulkMembershipActionUpdate
group_membershipedit-memberBulkPersonActionUpdate
group_membershipedit-tags-for-memberBulkPersonTagsActionUpdate
group_membershipinvite-memberBulkEmptyData
group_membershipremove-memberBulkEmptyData
group_membershipsend-member-emailBulkMemberEmailActionCreate
personadd-person-to-groupBulkMembershipActionCreate
personedit-personBulkPersonActionUpdate
personinvite-personBulkEmptyData
personarchive-personBulkEmptyData
personedit-tags-for-personBulkPersonTagsActionUpdate

Fields§

§action_context: Option<BulkJobCreateActionContext>

Context for action-based operations. Membership actions commonly require groupId.

§domain_object_identifiers: Vec<Value>

Targets to check or queue, in request order. Empty arrays are accepted. Prefer integer IDs for the registered jobs/actions.

§job_data: Value

Payload selected by the domain/key table.

§extra: Map<String, Value>

Fields not described by the spec, e.g. instance-specific DB fields.

Trait Implementations§

Source§

impl Clone for BulkJobCreate

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BulkJobCreate

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for BulkJobCreate

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BulkJobCreate

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for BulkJobCreate

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for BulkJobCreate

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BulkJobCreate

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more