All Categories

Developers

Apex API

DE Apex API Introduction

DE Apex API Introduction

Distribution Engine includes an Apex API consisting of global apex classes to access Distribution Engine features programmatically. Availability. Class Method Description n2de.DistributionEngineGloba…

This feature is available on the Advanced & Unlimited Tiers. Learn more

Distribution Engine includes an Apex API consisting of global apex classes to access Distribution Engine features programmatically.

Availability

Class	Method	Description
n2de.DistributionEngineGlobal	getUserAvailabilityAllTeams	Return online status for every Salesforce user in a DE team.
n2de.DistributionEngineGlobal	getAvailabilityByUser	Return online status for a given Salesforce user Id.
n2de.DistributionEngineGlobal	toggleUsers	Toggle a list of users on or offline in DE.

Classifier

Class	Method	Description
n2de.GlobalAPIClassifier	classifyRecords	Perform the requested classification on a given list of records.
n2de.GlobalAPIClassifier	bulkClassifyRecords	Perform the requested classification on a given list of records, accepts multiple configurations.

Out of Office

Class	Method	Description
n2de.GlobalAPIOutOfOffice	createOutOfOffices	Create out of office entries for the given users.
n2de.GlobalAPIOutOfOffice	deleteOutOfOffice	Delete an out of office entry.
n2de.GlobalAPIOutOfOffice	updateOutOfOffice	Update an out of office entry.

Rejection

Class	Method	Description
n2de.GlobalAPIReject	rejectAssignment	Reject one assignment giving a reason
n2de.GlobalAPIReject	rejectAssignments	Reject multiple assignments with reasons for each.

Team Members

Class	Method	Description
n2de.GlobalAPITeamMembers	addTeamMembersToTeam	Add new members to a team.
n2de.GlobalAPITeamMembers	removeTeamMembersFromTeam	Remove existing members from a team.
n2de.GlobalAPITeamMembers	removeUserFromTeams	Remove a user from all teams they are a member of.
n2de.GlobalAPITeamMembers	assignShiftToTeamMembers	Assign a shift to existing team members.

Tags

Class	Method	Description
n2de.GlobalAPITags	createOrUpdateTags	Create a new tag collection or update an existing tag collection with new tags.
n2de.GlobalAPITags	assignUserTags	Assign tags to users.
n2de.GlobalAPITags	unassignUserTags	Remove tags from users.
n2de.GlobalAPITags	getAssignedUserTags	Retrieve the tags assigned to users in DE.

Trigger Distribution

Class	Method	Description
n2de.GlobalAPITriggerDistribution	distributeObjectsInsideTrigger	When called from a trigger, will distribute all of the records that are part of that trigger, using the configured trigger distributors. If a "Is Trigger Enabled" field is defined, will only distribute those records where the field is checked. The records will be updated with the assignee but won't be saved, that will be left for the trigger.
n2de.GlobalAPITriggerDistribution	distributeObjectsInsideTrigger(List<SObject>)	When called from a trigger, will distribute all of the provided records using the configured trigger distributors. The records will be updated with the assignee but won't be saved, that will be left for the trigger.
n2de.GlobalAPITriggerDistribution	distributeObjects	Will distribute all of the provided records using the configured trigger distributors. The records will be updated with the assignee and saved.

System

Class	Method	Description
n2de.DistributionEngineGlobal	hasSchedulerFailed	Check if the Distribution Engine jobs have stopped running.
n2de.DistributionEngineGlobal	runHealthChecker	Run health checker to check and auto-restart DE in the event of any issues.

How did we do?

Rejection API