system.mes.signature.authorization.getPendingAuthRequests()

Sepasoft MES Module Suite

system.mes.signature.authorization.getPendingAuthRequests()

This function is essential for system monitoring and user interface development. It serves as the primary tool for querying the state of all currently active signature workflows, allowing you to retrieve a comprehensive list of every outstanding request. This is critical for building administrative dashboards, user-specific task lists, or any other UI component that needs to display pending actions.

Description: Retrieves a map of all pending authentication requests. The map's key is the request UUID, and its value is a complex object containing metadata about the request, such as the associated signature template.

Parameters

Parameter

Type

Purpose & Role

filter

AuthenticationChallengeFilter

Optional Filter: Allows you to limit the returned requests based on specific criteria. The filter object is created using system.mes.object.signature.filter.create(). This is useful for retrieving requests relevant to a specific user, role, or production area.


Returns

The function returns a Map that maps each request's UUID to a "Signature Request Info object." This object contains details about the pending request, such as the signature template being used. This key-value structure is ideal for iterating through pending requests to display their status, description, or other metadata in a UI component like a table or list.

Methods

  • Map getPendingAuthRequests()

    • Use Case: Retrieves all pending authentication requests across the entire system. Ideal for an administrative overview or system-wide monitoring.

  • Map getPendingAuthRequests(AuthenticationChallengeFilter filter)

    • Use Case: Retrieves a targeted subset of pending requests. For example, you can use a filter to build a view that shows a specific user only the requests that are currently awaiting their signature.



Sepasoft MES Module Suite