Expand GET /{{baseUrl}}v2.1/accounts/{{accountId}}/envelopes to have query parameters that search documents by documentFields[?(name=='text')].value and contains() filter like OData

this is the document of search envelopes:

https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/search/

the search contains text only support below:

FreeLink/甫连信息

🌍 Docusign Partner | Partner Profile

🏆 Docusign 2024 APAC Reseller Growth Partner of the Year

🌟 The only Docusign Partner globally certified as both a Certified eSignature Administrator and eSignature Technical Consultant.

📊 Docusign Community Leaderboard Top 5 contributor.

🚀 Expertise in Docusign integrations with on-premises systems for leading enterprises across various industries.

​@Hengfeng Ge  yes, I was reviewing that, and it is very weak, as it does not search documentFields[].  Signed-on-Paper string appears in envelopeDocuments[].name. 

There is not much of information at the envelope level except recipient, sender and status information - hence the name of the endpoint listStatusChanges.  

Proof related to this documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/

{{baseUrl}}v2.1/accounts/{{accountId}}/envelopes?search_text=Signed-on-Paper
returns
{

"errorCode": "INVALID_REQUEST_PARAMETER",

"message": "The request contained at least one invalid parameter. Query parameter 'from_date' must be set to a valid DateTime or 'envelope_ids', 'folder_ids' or 'transaction_ids' must be specified."

}

{{baseUrl}}v2.1/accounts/{{accountId}}/envelopes?search_text=Signed-on-Paper&from_date=2024-01-01
returns:

{

"resultSetSize": "0",

"totalSetSize": "0",

"nextUri": "",

"previousUri": ""

}

I have provided to support at least one envelope where the recipient uploaded an unsigned rendition of a document.

please reference:

/restapi/v2.1/accounts/xxx/envelopes?from_to_status=completed&include=recipients&from_date=2024-11-07T00:00+08:00&to_date=2024-11-07T23:59+08:00

https://eu.docusign.net/restapi/v2.1/accounts/xxx/envelopes?from_date=2024-04-13T16:00:00.000Z&to_date=2024-10-14T16:00:00.000Z&user_id=xxx&start_position=0&count=5&order=desc&order_by=last_modified&folder_types=inbox,sentitems&include=recipients,powerform,folders,delegations,workflow&include_purge_information=true&query_budget=10&exclude=recipient_sent_date

FreeLink/甫连信息

🌍 Docusign Partner | Partner Profile

🏆 Docusign 2024 APAC Reseller Growth Partner of the Year

🌟 The only Docusign Partner globally certified as both a Certified eSignature Administrator and eSignature Technical Consultant.

📊 Docusign Community Leaderboard Top 5 contributor.

🚀 Expertise in Docusign integrations with on-premises systems for leading enterprises across various industries.

Implementing an audit trail mechanism using DocuSign's Envelope Audit Events API involves retrieving and analyzing the envelope's audit log to detect specific user actions, such as the use of the Print and Sign feature. Here's how you can implement this step by step

1. Understand the Envelope Audit Events API

The Envelope Audit Events API provides a detailed log of actions performed on an envelope, such as document uploads, recipient interactions, and status changes. Each event includes details such as:

• Event type (e.g., PrintAndSign, DocumentUpload).
• User or recipient who triggered the event.
• Timestamp of the event.
• Envelope ID associated with the event.

2. API Endpoint

To retrieve audit events for an envelope, use the following endpoint:

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events

• Replace {accountId} with your DocuSign account ID.
• Replace {envelopeId} with the specific envelope's ID.

3. Analyze the Audit Log

The API response will include a list of audit events. You need to look for specific event types or actions that indicate the Print and Sign feature was used.

While the API does not include an explicit RecipientPrintAndSign event, you can analyze the envelope's audit trail by querying for all events and then programmatically identifying patterns or event descriptions that indicate relevant actions.

Here, you can find more information about this topic:https://www.docusign.com/blog/developers/common-api-tasks-parsing-envelopes-audit-events

It seems this post is no longer an Idea but a Question.  Hmmmm.

Are you telling me that it is my responsibility to have a periodic job that analyzes audit log of the platform, since the platform’s API endpoints don’t have the capability to give me the information I need with an explicit query parameter?  Even the audit_events resource should have a query parameter with an enumeration of the permissible event types, including eventType=RecipientPrintAndSign. 

It should NOT be restricted to a specific envelope.

I wanted to edit my above POST but it would not let me.  I did not mean a scheduled job, but an additional API call went I get the DocuSign Connect envelope event.  For the specific envelopeId, this is all the payload provides for matching:

                {

                    "name": "Message",

                    "value": "fullName uploaded a file that contains paper with hand signature"

                },

I prefer this type of call for my current use case:

GET /v2.1/accounts/{accountId}/envelopes/audit_events?eventType=RecipientPrintAndSign.