Skip to main content

Server-Side Open API

In addition to providing open APIs for client-side calls, the Yida platform also provides open APIs that support server-side calls. For details, please refer to the DingTalk Open Platform Documentation.

Usage Guide​

The steps to use the Yida platform server-side open APIs are shown below:

tip

The DingTalk Open Platform provides multiple application types. Different application types have different ways of using the server-side open APIs. Please refer to the DingTalk Application Types Introduction Document.

Step 1: Create a DingTalk Application​

Step 2: Add Interface Call Permissions​

After the application is created, only login and message notification interface call permissions are available by default. You need to add the corresponding interface usage permissions according to your development needs.

Step 3: Obtain the Application's access_token​

access_token is equivalent to an identity credential. When calling interfaces, access_token is used to authenticate the caller's identity.

API List​

Process​

API DescriptionInternal Enterprise ApplicationThird-Party Enterprise ApplicationThird-Party Personal ApplicationPermissions
Initiate Yida Approval ProcessSupportedSupportedNot SupportedYida Process Data Write Permission
Delete Process InstanceSupportedSupportedNot SupportedYida Process Data Write Permission
Terminate Process InstanceSupportedSupportedNot SupportedYida Process Data Write Permission

Form​

API DescriptionInternal Enterprise ApplicationThird-Party Enterprise ApplicationThird-Party Personal ApplicationPermissions
Query Form Instance DataSupportedSupportedNot SupportedYida Form Data Read Permission
Save Form DataSupportedSupportedNot SupportedYida Form Data Write Permission
Update Form DataSupportedSupportedNot SupportedYida Form Data Write Permission
Query Form DataSupportedSupportedNot SupportedYida Form Data Read Permission
Get Employee Component ValuesSupportedSupportedNot SupportedYida Form Data Read Permission
Get Form Component Definition ListSupportedSupportedNot SupportedYida Form Data Read Permission
Get Sub-table Component DataSupportedSupportedNot SupportedYida Form Data Read Permission
Delete Form DataSupportedSupportedNot SupportedYida Form Data Write Permission
Get Multiple Form Instance IDsSupportedSupportedNot SupportedYida Form Data Read Permission
Batch Get Form Instance DataSupportedSupportedNot SupportedYida Form Data Read Permission
Batch Delete Form InstancesSupportedSupportedNot SupportedYida Form Data Write Permission
Batch Create Form InstancesSupportedSupportedNot SupportedYida Form Data Write Permission
Batch Update Component Values in Form InstancesSupportedSupportedNot SupportedYida Form Data Write Permission
Create or Update Form InstanceSupportedSupportedNot SupportedYida Form Data Write Permission
Get Form Instance Data with Advanced Query Conditions (including sub-form component data)SupportedSupportedNot SupportedYida Form Data Read Permission
Get Form Instance Data with Advanced Query Conditions (excluding sub-form component data)SupportedSupportedNot SupportedYida Form Data Write Permission
Batch Update Form Instances with Form Instance DataSupportedSupportedNot SupportedYida Form Data Write Permission
Query Form Change RecordsSupportedSupportedNot SupportedYida Form Data Write Permission
Get Process Design StructureSupportedSupportedNot SupportedYida Form Data Write Permission
Get Component Alias ListSupportedSupportedNot SupportedYida Form Data Write Permission

Task​

API DescriptionInternal Enterprise ApplicationThird-Party Enterprise ApplicationThird-Party Personal ApplicationPermissions
Get Approval RecordsSupportedSupportedNot SupportedYida Process Data Read Permission
Agree or Disagree Yida Approval TaskSupportedSupportedNot SupportedYida Process Data Write Permission
Get Tasks Submitted by Someone in an OrganizationSupportedSupportedNot SupportedYida Process Data Read Permission
Get Completed Approval Tasks in an OrganizationSupportedSupportedNot SupportedYida Task Read Permission
Delegate TaskSupportedSupportedNot SupportedYida Task Write Permission
Query Process Running Tasks (VPC)SupportedSupportedNot SupportedYida Task Read Permission
Get Task List (Organization Dimension)SupportedSupportedNot SupportedYida Task Read Permission
Get Notifications Sent to UsersSupportedSupportedNot SupportedYida Task Read Permission
Query Copied to Me Task List (Application Dimension)SupportedSupportedNot SupportedYida Task Read Permission
Submit CommentSupportedSupportedNot SupportedYida Comment Write Permission
Batch Execute Yida Approval TasksSupportedSupportedNot SupportedYida Comment Write Permission
Batch Query Comments for Form InstancesSupportedSupportedNot SupportedYida Comment Write Permission

Attachment​

API DescriptionInternal Enterprise ApplicationThird-Party Enterprise ApplicationThird-Party Personal ApplicationPermissions
Get Yida Attachment Temporary Direct Access AddressSupportedSupportedNot SupportedYida Process Data Read Permission
This doc is generated using machine translation. Any discrepancies or differences created in the translation are not binding and have no legal effect for compliance or enforcement purposes.
Copyright © 2025钉钉（中国）信息技术有限公司和／或其关联公司浙ICP备18037475号-4