> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# サーバーサイド公開 API

> YiDA サーバーサイド公開 API の機能とエントリを整理し、DingTalk オープンプラットフォームを介したサーバーサイド連携によりフォームデータのバックエンド読み書きを実現する開発手順を解説します。

YiDA プラットフォームでは、クライアントサイド呼び出し用の公開 API に加え、サーバーサイド呼び出しに対応した公開 API も提供しています。詳細については、[DingTalk オープンプラットフォームのドキュメント](https://open.dingtalk.com/document/orgapp-server/yida-overview) をご参照ください。

## 使い方ガイド

以下の手順に沿って、YiDA サーバーサイド公開 API をご利用ください。

<Tip>
  DingTalk オープンプラットフォームには複数のアプリタイプがあり、サーバーサイド公開 API の利用方法もアプリタイプによって異なります。詳細については、[DingTalk アプリタイプの紹介](https://open.dingtalk.com/document/orgapp/untitled-document-1689231271995) をご参照ください。
</Tip>

### ステップ 1：DingTalk アプリの作成

* 社内アプリを作成する場合は、[社内アプリ開発プロセス概要](https://open.dingtalk.com/document/orgapp/overview-of-development-process) をご参照ください。
* サードパーティ社内アプリを作成する場合は、[サードパーティ社内アプリ概要](https://open.dingtalk.com/document/isvapp/isv-cooperation-guide) をご参照ください。

### ステップ 2：API 呼び出し権限の追加

アプリの作成直後は、ログインおよびメッセージ通知 API のみがデフォルトで有効になっています。開発ニーズに応じて、必要な API 権限を追加してください。

* 社内アプリの場合は、[API 呼び出し権限を追加する](/ja/open/development/add-api-permission) をご参照ください。
* サードパーティ社内アプリの場合は、[API 呼び出し権限を追加する](https://open.dingtalk.com/document/isvapp-server/add-interface-call-permissions?#topic-2149187) をご参照ください。

### ステップ 3：アプリの access\_token を取得

access\_token は認証情報として機能します。API を呼び出す際、access\_token によって呼び出し元の身元を認証します。

* 社内アプリの場合は、[社内アプリのアクセストークンを取得する](https://open.dingtalk.com/document/orgapp-server/obtain-the-access_token-of-an-internal-app#topic-2056397) をご参照ください。
* サードパーティ社内アプリの場合は、[認可された企業のアクセストークンを取得する](https://open.dingtalk.com/document/isvapp-server/obtain-the-access_token-of-the-authorized-enterprise?#topic-2056409) をご参照ください。

## API 一覧

### ワークフロー

| API 説明                                                                                             | 社内アプリ | サードパーティ社内アプリ | サードパーティ個人アプリ | 権限                   |
| :------------------------------------------------------------------------------------------------- | :---- | :----------- | :----------- | :------------------- |
| [YiDA 承認フローを開始する](https://open.dingtalk.com/document/orgapp/api-startinstance-v2)                  | 対応    | 対応           | 非対応          | YiDA ワークフローデータ書き込み権限 |
| [ワークフローインスタンスを削除する](https://open.dingtalk.com/document/orgapp-server/delete-process-instance)      | 対応    | 対応           | 非対応          | YiDA ワークフローデータ書き込み権限 |
| [ワークフローインスタンスを終了する](https://open.dingtalk.com/document/orgapp-server/terminate-a-process-instance) | 対応    | 対応           | 非対応          | YiDA ワークフローデータ書き込み権限 |

### フォーム

| API 説明                                                                                                                                                                      | 社内アプリ | サードパーティ社内アプリ | サードパーティ個人アプリ | 権限                 |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---- | :----------- | :----------- | :----------------- |
| [フォームインスタンスデータを検索する](https://open.dingtalk.com/document/orgapp/api-searchformdatas-v2)                                                                                      | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームデータを保存する](https://open.dingtalk.com/document/orgapp/api-saveformdata-v2)                                                                                               | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |
| [フォームデータを更新する](https://open.dingtalk.com/document/orgapp/api-updateformdata-v2)                                                                                             | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |
| [フォームデータを検索する](https://open.dingtalk.com/document/orgapp/api-getformdatabyid-v2)                                                                                            | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [社員コンポーネントの値を取得する](https://open.dingtalk.com/document/orgapp/gets-the-value-of-the-employee-component)                                                                      | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームコンポーネント定義一覧を取得する](https://open.dingtalk.com/document/orgapp/get-a-list-of-form-component-definitions)                                                                  | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [サブフォームコンポーネントのデータを取得する](https://open.dingtalk.com/document/orgapp/obtain-child-table-component-data)                                                                       | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームデータを削除する](https://open.dingtalk.com/document/orgapp/delete-form-data)                                                                                                  | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |
| [複数のフォームインスタンス ID を取得する](https://open.dingtalk.com/document/orgapp/api-searchformdataidlist-v2)                                                                             | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームインスタンスデータを一括取得する](https://open.dingtalk.com/document/orgapp/obtain-multiple-form-instance-data)                                                                        | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームインスタンスを一括削除する](https://open.dingtalk.com/document/orgapp/delete-multiple-form-instances)                                                                               | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームインスタンスを一括作成する](https://open.dingtalk.com/document/orgapp/create-multiple-form-instances)                                                                               | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームインスタンス内のコンポーネント値を一括更新する](https://open.dingtalk.com/document/orgapp/batch-update-of-component-values-in-form-instances)                                                 | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [フォームインスタンスを作成または更新する](https://open.dingtalk.com/document/orgapp/api-createorupdateformdata-v2)                                                                             | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [高度なクエリ条件でフォームインスタンスデータを取得する（サブフォームコンポーネントデータを含む）](https://open.dingtalk.com/document/orgapp/api-searchformdatasecondgeneration-v2)                                         | 対応    | 対応           | 非対応          | YiDA フォームデータ読み取り権限 |
| [高度なクエリ条件でフォームインスタンスデータを取得する（サブフォームコンポーネントデータを含まない）](https://open.dingtalk.com/document/orgapp/obtain-form-instance-data-using-advanced-query-conditions-excluding-subform) | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |
| [フォームインスタンスデータでフォームインスタンスを一括更新する](https://open.dingtalk.com/document/orgapp/update-multiple-form-instances-with-the-form-instance-data)                                     | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |
| [フォーム変更記録を検索する](https://open.dingtalk.com/document/orgapp/change-records-of-query-forms)                                                                                    | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |
| [ワークフロー設計構造を取得する](https://open.dingtalk.com/document/orgapp/api-getprocessdesign)                                                                                           | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |
| [コンポーネント表示名一覧を取得する](https://open.dingtalk.com/document/orgapp/api-getformcomponentaliaslist)                                                                                | 対応    | 対応           | 非対応          | YiDA フォームデータ書き込み権限 |

### タスク

| API 説明                                                                                                                             | 社内アプリ | サードパーティ社内アプリ | サードパーティ個人アプリ | 権限                   |
| :--------------------------------------------------------------------------------------------------------------------------------- | :---- | :----------- | :----------- | :------------------- |
| [承認記録を取得する](https://open.dingtalk.com/document/orgapp/queries-an-approval-record)                                                  | 対応    | 対応           | 非対応          | YiDA ワークフローデータ読み取り権限 |
| [YiDA 承認タスクを承認または却下する](https://open.dingtalk.com/document/orgapp/execute-approval-tasks)                                           | 対応    | 対応           | 非対応          | YiDA ワークフローデータ書き込み権限 |
| [組織内のメンバーが送信したタスクを取得する](https://open.dingtalk.com/document/orgapp/obtains-the-tasks-submitted-by-someone-in-an-organization)       | 対応    | 対応           | 非対応          | YiDA ワークフローデータ読み取り権限 |
| [組織内で完了した承認タスクを取得する](https://open.dingtalk.com/document/orgapp/obtains-the-completed-approval-tasks-in-an-organization)            | 対応    | 対応           | 非対応          | YiDA タスク読み取り権限       |
| [タスクを転送する](https://open.dingtalk.com/document/orgapp/transfer-tasks)                                                               | 対応    | 対応           | 非対応          | YiDA タスク書き込み権限       |
| [実行中のワークフロータスクを検索する（VPC）](https://open.dingtalk.com/document/orgapp/query-process-running-tasks-vpc)                               | 対応    | 対応           | 非対応          | YiDA タスク読み取り権限       |
| [タスクリストを取得する（組織スコープ）](https://open.dingtalk.com/document/orgapp/query-tasks-from-the-organization-dimension)                       | 対応    | 対応           | 非対応          | YiDA タスク読み取り権限       |
| [ユーザーに送信された通知を取得する](https://open.dingtalk.com/document/orgapp/get-notifications-sent-to-users)                                     | 対応    | 対応           | 非対応          | YiDA タスク読み取り権限       |
| [自分に CC された項目のタスクリストを検索する（アプリスコープ）](https://open.dingtalk.com/document/orgapp/query-copied-my-task-list-application-dimension)     | 対応    | 対応           | 非対応          | YiDA タスク読み取り権限       |
| [コメントを送信する](https://open.dingtalk.com/document/orgapp/submit-comment)                                                              | 対応    | 対応           | 非対応          | YiDA コメント書き込み権限      |
| [YiDA 承認タスクを一括実行する](https://open.dingtalk.com/document/orgapp/batch-execution-should-take-the-lead-of-approval-tasks)              | 対応    | 対応           | 非対応          | YiDA コメント書き込み権限      |
| [YiDA フォームインスタンスに対するコメントを一括検索する](https://open.dingtalk.com/document/orgapp/batch-query-of-comments-appropriate-for-form-instances) | 対応    | 対応           | 非対応          | YiDA コメント書き込み権限      |

### 添付

| API 説明                                                                                                                                      | 社内アプリ | サードパーティ社内アプリ | サードパーティ個人アプリ | 権限                   |
| :------------------------------------------------------------------------------------------------------------------------------------------ | :---- | :----------- | :----------- | :------------------- |
| [YiDA 添付の一時的なサイレントログイン URL を取得する](https://open.dingtalk.com/document/orgapp/obtain-the-temporary-free-access-address-of-yixian-accessories) | 対応    | 対応           | 非対応          | YiDA ワークフローデータ読み取り権限 |
