2022.04.21 update-OpenAPI new upgrade

版本范围: All versions are availableDoes not depend on creating an application 已全量发布Released to the DingTalk open platform

1. Upgrade overview

To better support ISVs or YIDA the strong needs of developers, YIDA release the potential of service providers and provide more open interface capabilities through OpenAPI.

Upgrade objectives:

1. openAPI support for all standard components
2. Improve the performance of CRUD interfaces commonly used by users (solve the problem of high timeout/failure rate)
3. Enhanced API availability/ease of use
4. DingTalk open platform openAPI documentationReadability enhancement (such as adding interface parameter descriptions and interface naming optimization)
5. Interface Support for batch operations of form CRUD
6. Some high-frequency scenarios are supported by open API.

DingTalk open platform [YIDA] added the following interfaces:

• AddObtain form instance data through advanced query conditions (excluding subform component data)API is used to query YIDA form instance data by using advanced search criteria, but does not return subform instance data in the form (to solve the API timeout problem caused by too many subforms in the form).
• AddObtain form instance data in batchesInterface to obtain data information of YIDA form instances in batches.
• AddDelete form instances in batchesInterface to delete YIDA form instances in batches.
• AddCreate form instances in batchesInterface to create YIDA form instances in batches.
• AddUpdate component values in a form instance in batchesInterface, which is used for batch Update to match form instances.
• AddUpdate form instances in batches through form Component DataInterface to modify the specified component value to update the form instance.
• AddAdd or update form instancesInterface, used to filter form instances based on filter conditions. If the filter conditions are met, the form instances that meet the query conditions are updated based on the specified form values. If the form instances that meet the filter conditions do not exist, adds a form instance based on the specified form value.
• AddQuery YIDA applicationsInterface to obtain the list of YIDA applications of the enterprise.
• AddQuery Form instances through advanced search criteriaInterface to filter YIDA approval instances by using advanced search criteria.
• AddQuery YIDA form Service Call Execution RecordsAPI to query service call records of a YIDA form instance.

2. Ability introduction

2.1 OpenAPI high-frequency scenario details upgrade list

Module	Interface name	Function description (user feedback)	DingTalk open platform interface documentation	Remarks
Platform	Query Service call records	YIDA service callback log open interface	https://open.dingtalk.com/document/orgapp-server/the-query-should-be-based-on-the-execution-records-of
	Obtain a list of YIDA applications in an organization	Add an interface to obtain a list of all APP details in the organization	https://open.dingtalk.com/document/orgapp-server/query-the-application-list
Data Query or operation	Query Form instances through advanced search criteria Query Form instance data Obtain a process instance	YIDA open interface allows you to query more than 5,000 data entries in a single query, and supports 3W entries.	https://open.dingtalk.com/document/orgapp-server/query-form-instances-using-advanced-search-conditions https://open.dingtalk.com/document/orgapp-server/querying-form-instance-data https://open.dingtalk.com/document/orgapp-server/obtain-process-instance	Switch to the new search storage structure and increase the maximum number of list queries from 5000 to 3W
	Query Form instances through advanced search criteria Obtain a process instance Query Form instance data	Single-line text queries through API interfaces can select fuzzy searchers to search accurately.	https://open.dingtalk.com/document/orgapp-server/query-form-instances-using-advanced-search-conditions https://open.dingtalk.com/document/orgapp-server/obtain-process-instance https://open.dingtalk.com/document/orgapp-server/querying-form-instance-data	before: Fuzzy search. The default operator is contains. After: supports precise/fuzzy search For all query class interfaces, if the input parameter is searchFieldJson, the input parameter now supports the query conditions used by data management,For more information, seeUse the filter criteria of the form "data management" for conditional search
	Obtain a process instance	External call [obtain instance details according to search criteria] interface plus filtering function of approval node	https://open.dingtalk.com/document/orgapp-server/obtain-process-instance	searchFieldJsonInput parameters now support the query conditions used by data management,For more information, seeUse the filter criteria of the form "data management" for conditional search
	Obtain a process instance	We recommend that you add a sort field to the parameters in the query instance details list based on conditions.	https://open.dingtalk.com/document/orgapp-server/obtain-process-instance	AddorderConfigJson input parameters. You can specify sorting rules, For more information about how to enter this parameter, seeBuilt-in fields that can participate in sorting search results.
	Obtain subtable component data	Add a separate query subtable interface	https://open.dingtalk.com/document/orgapp-server/obtain-child-table-component-data
	Obtain the primary table data	Add a single query primary table interface	https://open.dingtalk.com/document/orgapp-server/query-form-instance-data-using-advanced-query-conditions-and-do
	Add or update form instances	Add an upsert interface	https://open.dingtalk.com/document/orgapp-server/add-or-update-form-instances	Applicable:OpenAPI (whether it is an open platform or a front-end interface) must be subject to business association rules, such as verifying the unique value of the document number. (Currently, duplicates are hard to detect and cannot be directly see-through. For example, the unique value field is queried before each write, and more than two interfaces are called for one data.)
Batch operations	Create form instance data in batches	Add batch new interfaces	https://open.dingtalk.com/document/orgapp-server/create-multiple-form-instances	If you choose not to execute business rules, the number of form instances that can be created in batches at a time is 500 (you can apply for the upper limit for modification). If you choose to execute a business rule If synchronization is selected, 50 entries are allowed at a time. If asynchronous is selected, 200 entries are allowed at a time.
	Delete form instance data corresponding to multiple form instance IDs in batches	Add batch delete interfaces	https://open.dingtalk.com/document/orgapp-server/delete-multiple-form-instances	If you choose not to execute business rules, the number of form instances that can be deleted in batches at a time is 500 (you can apply for the upper limit of modification). If you choose to execute a business rule If synchronization is selected, 50 entries are allowed at a time. If asynchronous is selected, 300 entries are allowed at a time.
	Update the specified form component values of multiple form instances to the specified values Update form instances in batches through form instance data	Add batch modification interfaces	https://open.dingtalk.com/document/orgapp-server/batch-update-of-component-values-in-form-instances https://open.dingtalk.com/document/orgapp-server/update-multiple-form-instances-with-the-form-instance-data	If you choose not to execute business rules, the number of synchronous/asynchronous single batch modification form instances is 500 (you can apply for a maximum number of modifications) If you choose to execute a business rule If synchronization is selected, 50 entries are allowed at a time. If asynchronous is selected, 200 entries are allowed at a time.
	Obtain form instance data in batches	Add a batch query interface	https://open.dingtalk.com/document/orgapp-server/obtain-multiple-form-instance-data
Component	(Batch) create form instances	OpenAPI support for all standard components and add support for image Upload	[Batch creation]]https://open.dingtalk.com/document/orgapp-server/create-multiple-form-instances [Single creation]] https://open.dingtalk.com/document/orgapp-server/save-form-data
Other	YIDA the self-calling interface of the platform is unstable.	searchFieldJson.json occasionally fails to find data for a long time, especially after adding loading (after refreshing)	Solution: You can use/dingtalk/web/APP_PR185LWG5XWYCPITZ58C/query/formProcInstData/getInstanceDatasLight.json to set the size of the sub-table data for each query.

2.2DingTalk open platform open APIChange content:

1. The interface document that the user cannot use or does not need has been removed, as shown in the following figure.

2. Interface classification reinduction and adjustment

1. Some interfaces under the task category are adjusted to the form/process category.

3. Feedback

If you are using 【YIDA openAPI] if you encounter problems or have suggestions, you can scan the QR code below and join the YIDA experience center for feedback.

-------------------- Get the latest information YIDA, welcome to follow US--------------------