Business Process Management Microservice

A host of different APIs allow queue management for cases, handling of notes and configuration of case handling memberships for Contact Center and Retail Store Agents.

APIs

addMemberToQueue

The purpose of the addMemberToQueue API is to add members to a specific catalog queue.

addMemberUnavailabilityInfo

The purpose of the addMemberUnavailabilityInfo API is to create a new queue member unavailability information.

addNotetoProcessInstance

The purpose of the addNotetoProcessInstance API is to add note to instance document for any note added.

assignChannelToCart

The purpose of the assignChannelToCart API is to assign process instance to channel.

assignMember

The purpose of the assignMember API service is to retrieve the next queue member so it can be assigned to the case.

assignWorkflowToUser

The purpose of the assignWorkflowToUser API service is to assign workflow to user, that will assign or reassign a user to a process.

cartCreditEvaluationHistory

The purpose of the cartCreditEvaluationHistory API is to retrieve the credit details of a customer's account.

cartProcessInstanceCreationNCA

The purpose of the cartProcessInstanceCreationNCA API is to create process instance for cart using cart ID.

changeState

The purpose of the changeState API service is to change the technical state of a case to next status.

closeServiceDeskTicket

The purpose of the closeServiceDeskTicket API is to close the service desk ticket for an associated case in a third party service desk system.

createCartProcessFireSignal

The purpose of the createCartProcessFireSignal API is to initiate a signal based on the type of signal recieved.

createProcessInstance

The purpose of the createProcessInstance API is to create a process instance and the API passes this information to the process attributes in Rule Engine.

createQueueWithMembers

The purpose of the createQueueWithMembers API is to create a new queue in the catalog module with its members.

createServiceDeskTicket

The purpose of the createServiceDeskTicket API is to create a service desk ticket for an associated case in the third-party system.

creditEvaluationHistory

The purpose of the creditEvaluationHistory API is to retrieve the credit details of a customer's account.

deactivateqQueueById

The purpose of the deactivateqQueueById API is to expire or deactivate any existing queue, only if queue does not have any open case associated with it and is not the default queue.

deleteProcessInstance

The purpose of the deleteProcessInstance API is to delete the case templates associate data from an existing case or process instance.

firesignal

The purpose of the firesignal API is to initiate a signal based on the type of signal recieved.

getMemberUnavailabilityInfo

The purpose of the getMemberUnavailabilityInfo API is to retrieve the non-availability information of the queue members.

guideProcessInstanceToQueue

The purpose of the guideProcessInstanceToQueue API is to guide process instance to a different queue.

guideProcessToQueue

The purpose of the guideProcessToQueue API is to guide process instance to a different queue.

handleProcessAction

The purpose of the handleProcessAction API is to handle the process based on the action taken by the user.

isSDTRequired

The purpose of the isSDTRequired API is used to know the service desk ticket needs to be created for a Workflow (case).

isSDTRequiredUI

The purpose of the isSDTRequired API is to know the service desk ticket that needs to be created for a workflow (case).

processHistoryRetrive

The purpose of the processHistoryRetrive API is to retrieve the history details of the business process based on the cart ID.

reassessServiceDeskTicket

The purpose of the reassessServiceDeskTicket API is to reassess the service desk ticket for an associated case ina third party service desk module.

recordSLAViolation

The purpose of the recordSLAViolation API service is used to log the SLA violation history in process instance document.

removeAssigneeFromQueue

The purpose of the removeAssigneeFromQueue API is to remove the assignee from the case assigned to it in that queue with no change to the assigned queue.

removeMemberUnavailabilityInfo

The purpose of the removeMemberUnavailabilityInfo API is to remove the queue member unavailability information based on the user ID and user non-available ID.

removeQueueMembers

The purpose of the removeQueueMembers API is to remove the members from the queue, based on the identity defined for a particular role and class.

retrieveCaseTemplates

The purpose of the retrieveCaseTemplates API is to retrieve the list of all case templates configured for a given case type or sub-type or channel or technical state.

retrievelifecycleStateSpecByFilter

The purpose of the retrievelifecycleStateSpecByFilter API is to retrieve a list of process states along with their super states.

retrieveProcessInstanceHistory

The purpose of the retrieveProcessInstanceHistory API is to retrieve the process instance history.

retrieveProcessInstances

The purpose of the retrieveProcessInstances API is to retrieve the process instance based on filters, supported by query parameters.

retrieveProcessNotes

The purpose of the retrieveProcessNotes API is to get comments associated with the process.

retrieveProcessType

The purpose of the retrieveProcessType API is to retrieve the process type and its sub-types on the basis of Process Type ID.

retrieveProcessTypeByAccountId

The purpose of the retrieveProcessTypeByAccountId API is to retrieve the process type and its sub-types on the basis of account ID only for the Case Managment related domain.

retrieveQueueByFilters

The purpose of the retrieveQueueByFilters API is to retrieve the process queue information based on filters, supported by query parameters.

retrieveQueueById

The purpose of the retrieveQueueById API is to retrieve the queue information based on Queue ID.

retrieveQueueGroups

The purpose of the retrieveQueueGroups API is to retrieve list of groups associated with a queue.

retrieveQueueMembers

The purpose of the retrieveQueueMembers API is to retrieve list of users associated with a queue.

sendExternalNotification

The purpose of the sendExternalNotification API is to trigger the external notification for a business process instance. In addition, API pass through Rule Engine. Rule Engine project: businessProcessNotifAndAng.

triggerHistoryLog

The purpose of the triggerHistoryLog API is to update the process instance history based on the action taken by the user.

updateIsLocked

The purpose of the updateIsLocked API is to update the re-assignment indicator of process instance for cart and cart action.

updateMemberUnavailabilityInfo

The purpose of the updateMemberUnavailabilityInfo API is to add a queue member non-availability information of a new user.

updateProcessInstanceAttributes

The purpose of the updateProcessInstanceAttributes API is to update a process to modify process attributes based on the state of the process.

updateProcessInstanceStateChange

The purpose of the updateProcessInstanceStateChange API is to update the process instance document properly for any state change.

updateQueueById

The purpose of the updateQueueById API is to update the queue information based on the Queue ID.

updateQueueOwners

The purpose of the updateQueueOwners API service is to change the owner to member, or update allow assignment of owner, or add a new owner to a queue based on the queue ID.

updateServiceDeskTicket

The purpose of the updateServiceDeskTicket API is to update a service desk ticket for an associated case in the third-party system.

validateBusinessProcessInstanceId

The purpose of the validateBusinessProcessInstanceId API is to validate business process instance. In addition, API pass through Rule Engine. Rule Engine project: businessProcessState.