メインコンテンツまでスキップ

クロスアプリケーションデータソースAPI

宜搭はリモートAPI呼び出し機能を提供しており、HTTPリクエストを通じて非同期インターフェースを呼び出すことができます（詳細な使用方法はリモートAPIドキュメントを参照）。これと同時に、宜搭プラットフォームでは宜搭データ操作用にいくつかの組み込みリモートAPIも提供しています。

注意

宜搭が提供するOpenAPI呼び出しには認証が必要であるため、ログイン不要ページではリモートOpenAPIを直接使用できません。FaaSまたは独自サービスで中継して呼び出すことができます。

API呼び出し説明​

リクエストパス​

宜搭はアプリケーション単位の複数のインターフェースを提供しており、アプリケーション内で以下のようにしてリモートAPIを呼び出すことができます（クロスアプリケーション呼び出しをサポート）。

# アプリケーションコードは、アプリケーション設定=》デプロイメント・運用ページで確認できます
# インターフェースパスは下記ドキュメントを参照してください。異なるAPIが異なるインターフェースパスを提供します
"/dingtalk/web/${アプリケーションコード}/${インターフェースパス}"
ヒント

宜搭プラットフォームで記述したインターフェースリクエストコードは、企業のサブドメイン変更によるコード調整を避けるために、相対パスを直接使用してください。

/dingtalk/web/APP_X1X2X3X4/v1/form/searchFormDatas.json

インターフェース返却構造​

宜搭プラットフォームが提供するリモートAPIの返却構造は以下の通りです：

interface IResponse {
  success: boolean; // リクエストが成功したかどうか
  result?: object | array | string; // リクエスト成功時の返却内容
  errorMsg?: string; // エラーメッセージ
  errorCode?: string; // エラーコード
  errorLevel?: number; // エラーレベル
}

フォーム関連API​

宜搭プラットフォームはフォームタイプのページを提供してフォームデータ収集を行い、フォーム関連APIはフォームデータに対する追加・削除・変更・検索操作に使用されます。以下に記載されているフォームインスタンスは、実際にはフォームデータ集合の中の1つのデータを指します。

フォームインスタンスの新規作成​

  • インターフェースパス： /v1/form/saveFormData.json
  • リクエストタイプ： POST
  • パラメータ：( formDataJson は JSON.stringify() 関数を使用してオブジェクトを直列化する必要があります)
パラメータ名説明必須例備考
formUuidフォームIDはいFORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB
appTypeアプリケーションIDはいAPP_DR4OK27ZKL5N22B907E8
formDataJsonフォームデータはい{"textField_jcpm6agt": "シングルライン", "employeeField_jcos0sar": ["workno"]}参考：付録1 保存/更新 フォームデータ形式説明
  • 返却値の例：
{
  "result": "FINST-EF6Y93URN2UZ1SBPLIP9NAV6HR2GEO1Z4ZCHSCJ0",
  "success": true
}

フォームの指定コンポーネント値を更新​

  • インターフェース： /v1/form/updateFormData.json
  • リクエストタイプ： POST
  • パラメータ：
パラメータ名説明必須例備考
formInstId更新するフォームデータIDはいFINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9
updateFormDataJson更新するフォームコンポーネント値、必須はい{"employeeField_jcpm5gy2": ["xxxxx", "yyyyy"]}参考：付録1 保存/更新 フォームデータ形式説明。指定したコンポーネントは更新され、指定されていないコンポーネントは変更されません。明細の値は統一更新のみで、サブフォームの特定コンポーネントのみを更新することはできません。
useLatestVersion最新のフォームバージョンで更新いいえy参考：付録1 保存/更新 フォームデータ形式説明「特記注意」
  • 返却値の例：
{
  "success": true
}

フォームインスタンスの削除​

  • インターフェース： /v1/form/deleteFormData.json
  • リクエストタイプ： POST
  • パラメータ：
パラメータ名説明必須例備考
formInstId削除するフォームデータIDはいFINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9
  • 返却値の例：
{
  "success": true
}

フォームインスタンスIDによるフォームインスタンス詳細の検索​

  • インターフェース： /v1/form/getFormDataById.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
formInstId検索するフォームデータIDはいFINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9
  • 返却値の例：
{
  "success": "リクエストが成功したかどうか",
  "errorMsg": "エラーメッセージ",
  "errorCode": "エラーコード",
  "result": "フォームインスタンス詳細👇🏻👇🏻👇🏻"
}

result は付録5. フォームインスタンス詳細オブジェクト形式説明を参照

条件によるフォームインスタンスIDリストの検索​

  • インターフェース： /v1/form/searchFormDataIds.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
formUuidフォームIDはいFORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3
searchFieldJsonフォーム内コンポーネント値による検索いいえ形式は付録2：コンポーネント値による条件検索を参照、コンポーネント値形式説明
currentPage現在のページいいえ10より大きくなければならない。デフォルト：1
pageSize1ページあたりのレコード数いいえ100より大きくなければならない。デフォルト：10。100より大きくすることはできません
originatorIdデータ提出者社員番号による検索いいえ
createFromcreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式
createTocreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式。createFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に作成されたデータを検索します。
modifiedFrommodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式
modifiedTomodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索。いいえ2018-02-01文字列形式、yyyy-MM-DD形式。modifiedFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に変更されたデータを検索します。
dynamicOrderソートいいえcolumn: '+'column: '+'
  • 返却値の例：
{
  "result": {
    "data": ["FINST-EF6Y93URN2F02S745LTMW2D2G4WVDS16O17ISCJ0"],
    "totalCount": 1,
    "currentPage": 1
  },
  "success": true
}

条件によるフォームインスタンス詳細リストの検索​

  • インターフェース： /v1/form/searchFormDatas.json
  • リクエストタイプ： GET
  • 権限制御：このインターフェースはページ設定の権限制御の影響を受けます（管理者を除く）
  • パラメータ：
パラメータ名説明必須例備考
formUuidフォームIDはいFORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3
searchFieldJsonフォーム内コンポーネント値による検索いいえ形式は付録2：コンポーネント値による条件検索を参照、コンポーネント値形式説明
currentPage現在のページいいえ10より大きくなければならない。デフォルト：1
pageSize1ページあたりのレコード数いいえ100より大きくなければならない。デフォルト：10。100より大きくすることはできません
originatorIdデータ提出者社員番号による検索いいえ
createFromcreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式（または秒単位のyyyy-MM-DD HH:mm:ss）
createTocreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式（または秒単位のyyyy-MM-DD HH:mm:ss） createFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に作成されたデータを検索します。
modifiedFrommodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式（または秒単位のyyyy-MM-DD HH:mm:ss）｜
modifiedTomodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索。いいえ2018-02-01文字列形式、yyyy-MM-DD形式。（または秒単位のyyyy-MM-DD HH:mm:ss）modifiedFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に変更されたデータを検索します。
dynamicOrderソートいいえ{"numberField_1ac":"+"}numberField_1acフィールドで昇順に並べ替えます
  • 返却値の例：
{
  "success": true,
  "errorCode": "",
  "errorMsg": "",
  "result": {
    "data": [],
    "totalCount": 1,
    "currentPage": 1
  }
}

フォーム定義の取得​

このインターフェースは2024年12月1日にアップグレードされ、アップグレード後のインターフェースは通常ユーザーの使用をサポートせず、管理者のみ呼び出しが可能です。

  • インターフェース： /v1/form/getFormComponentDefinationList.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
formUuidフォームIDはいFORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB
versionフォームバージョンいいえFINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9formData中のversionフィールドを渡すことができます。
空白の場合は最新バージョン定義を返します
  • 返却値の例：
{
    "success":true,
    "content":[
        {
            "label":"{"en_US":"CheckBox Field", "zh_CN":"複数選択", "type":"i18n"}",
            "key":"checkboxField_jiwvhkdi"
        },
        {
            "label":"{"en_US":"Textarea Field", "zh_CN":"複数行入力", "type":"i18n"}",
            "key":"textareaField_jiwvhkdh"
        },
        {
            "label":"{"en_US":"Select Field", "zh_CN":"ドロップダウン単一選択", "type":"i18n"}",
            "key":"selectField_jiwvhkdg"
        }
    ]
}

サブフォームデータの取得​

  • インターフェース： v1/form/listTableDataByFormInstIdAndTableId.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
formUuidフォームIDはいFORM-NJYJZELV8YZRDEI2N5IQ7L6VEDMR1VE9GMPCJB
formInstanceId検索するインスタンスのインスタンスIDはいFINST-NJYJZELVVYZRVGJHR7M6FJW3ESJN1P1TCNPCJ9
tableFieldId検索するサブフォームコンポーネントの唯一識別子はいtableField_ksyaujq1
currentPage現在のページいいえ100より大きくなければならない。デフォルト：1
pageSize1ページあたりのレコード数いいえ500より大きく50より小さくなければならない。デフォルト：10
  • 返却値の例：
{
  "result": {
    "data": [
      {
        "textField_kstqokaa": ""
      },
      {
        "textField_kstqokaa": "1"
      },
      {
        "textField_kstqokaa": "2"
      }
    ],
    "totalCount": 120,
    "currentPage": 1
  },
  "success": true
}

フロー関連API​

フローフォームも宜搭プラットフォームが提供する基本機能の一つであり、フロー関連APIはフローに対する関連操作に使用されます。

フロー発行​

  • インターフェースパス： /v1/process/startInstance.json
  • リクエストタイプ： POST
  • パラメータ：
パラメータ名説明必須例備考
processCodeフローコードはいTPROC--EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ4 ｜ 単独発行ページリンクで確認可能
formUuidフォームIDはいFORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3 ｜ 単独発行ページリンクで確認可能
formDataJsonフォームデータはい参考：付録1 保存/更新 フォームデータ形式説明
deptId発行者の所属部署番号いいえ18295未記入の場合、発行者メイン部署がデフォルトになります
  • 返却値の例：
{
  "result": "f30233fb-72e1-4af4-8cb8-c7e0ea9ee530",
  "success": true
}

条件によるフローインスタンスIDの検索​

  • インターフェースパス： /v1/process/getInstanceIds.json
  • リクエストタイプ： GET
  • 権限説明：フローはインスタンス参照可能権限を設定する必要があります（管理者を除く）
  • パラメータ：
パラメータ名説明必須例備考
formUuidフォームIDはいFORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3
searchFieldJsonフォーム内コンポーネント値による検索いいえ形式は付録2：コンポーネント値による条件検索を参照、コンポーネント値形式説明
taskIdタスクIDいいえ2199132092通常は使用しません
instanceStatusインスタンス状態いいえRUNNING選択可能値：RUNNING, TERMINATED, COMPLETED, ERROR。それぞれ：実行中、終了、完了、異常を表します。
approvedResultフロー審査結果いいえagree選択可能値：agree, disagree。それぞれ：同意、拒否を表します。
currentPage現在のページいいえ10より大きくなければならない。デフォルト：1
pageSize1ページあたりのレコード数いいえ100より大きくなければならない。デフォルト：10。100より大きくすることはできません
originatorIdフロー発行者社員番号による検索いいえ
createFromcreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式 yyyy-MM-DD
createTocreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索。いいえ2018-01-01文字列形式、yyyy-MM-DD形式。createFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に作成されたデータを検索します。
modifiedFrommodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式
modifiedTomodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索。いいえ2018-01-01文字列形式、yyyy-MM-DD形式。modifiedFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に変更されたデータを検索します。
  • 返却値の例：
{
  "result": {
    "data": [
      "f30233fb-72e1-4af4-8cb8-c7e0ea9ee530",
      "bc0950a3-fe1b-459c-b6ba-282be38523ab",
      "f540cbd7-43eb-40de-b915-6716578a2802"
    ],
    "totalCount": 3,
    "currentPage": 1
  },
  "success": true
}

検索条件によるインスタンス詳細リストの取得​

  • インターフェースパス： /v1/process/getInstances.json
  • リクエストタイプ： GET
  • 権限説明：フローはインスタンス参照可能権限を設定する必要があります（管理者を除く）
  • パラメータ：
パラメータ名説明必須例備考
formUuidフォームIDはいFORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3
searchFieldJsonフォーム内コンポーネント値による検索いいえ形式は付録2：コンポーネント値による条件検索を参照、コンポーネント値形式説明
taskIdタスクIDいいえ2199132092通常は使用しません
instanceStatusインスタンス状態いいえRUNNING選択可能値：RUNNING, TERMINATED, COMPLETED, ERROR。
それぞれ：実行中、終了、完了、異常を表します。
approvedResultフロー審査結果いいえagree選択可能値：agree, disagree。それぞれ：同意、拒否を表します。
currentPage現在のページいいえ10より大きくなければならない。デフォルト：1
pageSize1ページあたりのレコード数いいえ100より大きくなければならない。デフォルト：10。100より大きくすることはできません
originatorIdフロー発行者社員番号による検索いいえ
createFromcreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式 yyyy-MM-DD
createTocreateFromとcreateToの2つの時間で期間を構成します。この期間に作成されたデータリストを検索。いいえ2018-01-01文字列形式、yyyy-MM-DD形式。createFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に作成されたデータを検索します。
modifiedFrommodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索いいえ2018-01-01文字列形式、yyyy-MM-DD形式
modifiedTomodifiedFromとmodifiedToで期間を構成し、この期間に変更されたデータリストを検索。いいえ2018-01-01文字列形式、yyyy-MM-DD形式。modifiedFromと合わせて、2018-01-01から2018-01-31（01日と31日を含む）の間に変更されたデータを検索します。
  • 返却値の例：
{
  "success": true,
  "errorCode": "",
  "errorMsg": "",
  "result": {
    "data": [],
    "totalCount": 1,
    "currentPage": 1
  }
}

インスタンスIDによるフローインスタンス詳細の取得​

  • インターフェースパス： /v1/process/getInstanceById.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
processInstanceIdフローインスタンスIDはいf30233fb-72e1-4af4-8cb8-c7e0ea9ee530
  • 返却値の例：
{
  "success": true,
  "errorCode": "",
  "errorMsg": "",
  "result": "インスタンス詳細、[付録3-フローインスタンス詳細オブジェクト形式説明](#フローインスタンス詳細オブジェクト形式説明)を参照"
}

フローインスタンスの削除​

  • インターフェースパス： /v1/process/deleteInstance.json
  • リクエストタイプ： POST
  • パラメータ：
パラメータ名説明必須例備考
processInstanceIdフローインスタンスIDはいf30233fb-72e1-4af4-8cb8-c7e0ea9ee530
  • 返却値の例：
{
  "success": true,
  "errorCode": "",
  "errorMsg": ""
}

フローインスタンスの終了​

  • インターフェースパス： /v1/process/terminateInstance.json
  • リクエストタイプ： POST
  • パラメータ：
パラメータ名説明必須例備考
processInstanceIdフローインスタンスIDはいf30233fb-72e1-4af4-8cb8-c7e0ea9ee530
  • 返却値の例：
{
  "success": true,
  "errorCode": "",
  "errorMsg": ""
}

シングルタスクインターフェース実行​

  • インターフェースパス： /v1/task/executeTask.json
  • リクエストタイプ： POST
  • パラメータ：
パラメータ名説明必須例備考
taskIdタスクIDはい12002575
procInstIdインスタンスIDはいf30233fb-72e1-4af4-8cb8-c7e0ea9ee530
outResult審査結果はいAGREEAGREE(同意)、DISAGREE(不同意)
remark審査意見はい確認同意
formDataJson審査意見いいえ確認同意参考：付録1 保存/更新 フォームデータ形式説明。
指定したコンポーネントは更新され、指定されていないコンポーネントは変更されません。明細の値は統一更新のみで、サブフォームの特定コンポーネントの値のみを更新することはできません。
noExecuteExpressions検証&関連操作を実行しないかいいえyこのタスクノードに検証ルールまたは関連操作がバインドされている場合、
y -> 検証ルール&関連操作を実行しない n -> 検証ルール&関連操作を実行する。未指定の場合はデフォルトn、つまり検証ルール&関連操作を実行します。
  • 返却値の例：
{
  "success": "リクエストが成功したかどうか",
  "errorCode": "エラー情報",
  "errorMsg": "エラーコード"
}

審査記録の取得​

  • インターフェースパス： /v1/process/getOperationRecords.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
processInstanceIdフローインスタンスIDはいf30233fb-72e1-4af4-8cb8-c7e0ea9ee530
  • 返却値の例：
{
  "success": true,
  "content": [
    {
      "operateTime": "2018-06-22 14:35:40",
      "remark": "",
      "taskHoldTime": 0,
      "type": "HISTORY",
      "operatorName": "宜小搭",
      "operator": "yida",
      "activityId": "sid-restartevent",
      "action": "申請提出",
      "actionExt": "submit",
      "id": 2846866118,
      "operatorPhotoUrl": "/photo/yida.128x128.jpg",
      "processInstanceId": "8c124808-82e7-473b-9a7a-43c29b310837",
      "showName": "申請提出",
      "operateType": "NEW_PROCESS",
      "domains": [],
      "operatorStatus": "A",
      "operatorAgentIds": [],
      "size": 1,
      "operatorDisplayName": "宜小搭",
      "taskId": "null"
    },
    {
      "taskHoldTime": 531398377,
      "type": "TODO",
      "operatorName": "宜小搭",
      "operator": "yida",
      "activityId": "sidJIOB2P2J1JW3RPMDOS28",
      "taskType": "COMMON_ALL_AT_ONCE",
      "actionExt": "doing",
      "operatorPhotoUrl": "/photo/yida.128x128.jpg",
      "processInstanceId": "8c124808-82e7-473b-9a7a-43c29b310837",
      "showName": "実行者",
      "activeTime": "2018-06-22 14:35:41",
      "domains": [],
      "operatorStatus": "A",
      "operatorAgentIds": [],
      "size": 1,
      "operatorDisplayName": "宜小搭",
      "taskId": "2846866145"
    }
  ]
}

フローインスタンス更新​

  • インターフェースパス： /v1/process/updateInstance.json
  • リクエストタイプ： POST
  • パラメータ：
パラメータ名説明必須例備考
processInstanceIdインスタンスIDはい
updateFormDataJson更新するフォームデータはい参考：付録1 保存/更新 フォームデータ形式説明
  • 返却値の例：
{
  "success": true
}

タスクセンター関連API​

宜搭プラットフォームは、現在の組織下のすべてのアプリケーションのタスクリストとその状態を表示するのに使用されるタスクセンターを提供しています。タスクセンター関連APIは、タスクセンター内のタスクリストに対する検索操作に使用されます。

提出済みタスク​

  • インターフェースパス： /v1/process/getMySubmitInApp.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
pageSize1ページあたりのレコード数はい100より大きくなければならない。デフォルト：10 最大値：100
currentPage現在のページはい10より大きくなければならない。デフォルト：1
keywordキーワードいいえ
  • 返却値の例：
    • 成功
{
  "result": {
    "data": [
      {
        "modifiedTime": "2018-04-12 19:44:14",
        "formInstanceId": "FINST-AJ1L4CJVXL0UIAIPR06ZA52U9HKUXXXXXX",
        "title": "伝票",
        "instValue": [
          {
            "componentId": "node_jfwgghbo",
            "componentName": "TextField",
            "fieldId": "textField_jfwggg8e",
            "label": "氏名",
            "validation": [],
            "fieldData": {
              "complexType": "custom",
              "dataType": "CHANGED",
              "pass": true,
              "value": "jack"
            },
            "errorMsg": null,
            "hasError": false
          }
        ],
        "processId": 0,
        "appType": "APP_R8MYLKYXXXXXX",
        "dataMap": {
          "textField_jfXXXXXX": "XXXXXX"
        },
        "originatorId": "XXXXXX",
        "formUuid": "FORM-0G7KPV3WZL0U3AHTOA9BFVXXXXXX",
        "dataType": "finst",
        "originatorAvatar": "http://static.dingtalk.com/media/lADPBbCc1R7VwSHNXXXXXX.jpg",
        "version": 0,
        "createTime": "2018-04-12 19:44:14"
      }
    ],
    "totalCount": 1,
    "currentPage": 1
  },
  "success": true
}
  • 失敗
{
  "errorCode": "TIANSHU_000006",
  "success": false,
  "errorMsg": "権限がありません"
}

未完了タスク​

  • インターフェースパス： /v1/task/getTodoTasksInApp.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
pageSize1ページあたりのレコード数はい100より大きくなければならない。デフォルト：10 最大値：100
currentPage現在のページはい10より大きくなければならない。デフォルト：1
keywordキーワードいいえ
  • 返却値の例：
    • 成功
{
  "result": {
    "data": [
      {
        "processInstanceId": "XXXXXX",
        "originatorName": "XXX",
        "title": "XXXが発行したフロー",
        "originatorPhoto": "http://static.dingtalk.com/media/lADPdfafafsAXXXXXX.jpg",
        "titleEn": "XXXが発行したフロー",
        "createTime": "2018-04-13 13:35:58",
        "appType": "APP_R8MdfadfXXXXXX",
        "originatorNameEn": "XXXXXX",
        "originatorId": "XXXXXX",
        "taskId": "XXXXXX",
        "status": "NEW"
      }
    ],
    "totalCount": 1,
    "currentPage": 1
  },
  "success": true
}
  • 失敗
{
  "errorCode": "TIANSHU_000006",
  "success": false,
  "errorMsg": "権限がありません"
}

完了済みタスク​

  • インターフェースパス： /v1/task/getDoneTasksInApp.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
pageSize1ページあたりのレコード数はい100より大きくなければならない。デフォルト：10 最大値：100
currentPage現在のページはい10より大きくなければならない。デフォルト：1
keywordキーワードいいえ
  • 返却値の例：
    • 成功
{
  "result": {
    "data": [
      {
        "processInstanceId": "abc434rfds23XXXXXX",
        "finishTime": "2018-03-28 17:46:14",
        "originatorName": "",
        "title": "XXXが発行したフローページ",
        "originatorPhoto": "//img.alicdn.com/tfs/TB1msdfsXXXXXX.jpg",
        "titleEn": "XXXが発行したフローページ",
        "createTime": "2018-03-28 17:45:43",
        "appType": "XXXXXX",
        "originatorNameEn": "XXXXXX",
        "originatorId": "XXXXXX",
        "taskId": "XXXXXX",
        "status": "COMPLETED"
      }
    ],
    "totalCount": 1,
    "currentPage": 1
  },
  "success": true
}
  • 失敗
{
  "errorCode": "TIANSHU_000006",
  "success": false,
  "errorMsg": "権限がありません"
}

抄送されたタスク（アプリケーション単位）​

  • インターフェースパス： /v1/task/getNotifyMeTasksInApp.json
  • リクエストタイプ： GET
  • パラメータ：
パラメータ名説明必須例備考
pageSize1ページあたりのレコード数はい100より大きくなければならない。デフォルト：10 最大値：100
currentPage現在のページはい10より大きくなければならない。デフォルト：1
keywordキーワードいいえ
processCodesprocessCodesいいえ["xx", "xxx"]
instanceStatusインスタンス状態いいえ列挙値
  • 返却値の例：
    • 成功
{
  "result": {
    "data": [
      {
        "modifiedTime": "2018-04-12 19:44:14",
        "formInstanceId": "FINST-AJ1L4CJVXL0UIAIPR06ZA52U9HKUXXXXXX",
        "title": "伝票",
        "instValue": [
          {
            "componentId": "node_jfwgghbo",
            "componentName": "TextField",
            "fieldId": "textField_jfwggg8e",
            "label": "氏名",
            "validation": [],
            "fieldData": {
              "complexType": "custom",
              "dataType": "CHANGED",
              "pass": true,
              "value": "jack"
            },
            "errorMsg": null,
            "hasError": false
          }
        ],
        "processId": 0,
        "appType": "APP_R8MYLKYXXXXXX",
        "dataMap": {
          "textField_jfXXXXXX": "XXXXXX"
        },
        "originatorId": "XXXXXX",
        "formUuid": "FORM-0G7KPV3WZL0U3AHTOA9BFVXXXXXX",
        "dataType": "finst",
        "originatorAvatar": "http://static.dingtalk.com/media/lADPBbCc1R7VwSHNXXXXXX.jpg",
        "version": 0,
        "createTime": "2018-04-12 19:44:14"
      }
    ],
    "totalCount": 1,
    "currentPage": 1
  },
  "success": true
}
  • 失敗
{
  "errorCode": "TIANSHU_000006",
  "success": false,
  "errorMsg": "権限がありません"
}

付録​

保存/更新 フォームデータ形式説明​

  • フォーム内の各コンポーネントには一意のIDがあります（ページデザイナーのコンポーネント右側の高度パネルで一意識別子を確認できます）。各コンポーネントに入力されたデータにはそれぞれ固定の形式があります。現在サポートされているフォームコンポーネントには、シングルライン、マルチライン、数字、単一選択、ドロップダウン単一選択、複数選択、ドロップダウン複数選択、日付、日付間隔、人員検索ボックス、地域選択、部署選択、カスケード選択、サブフォームコンポーネントがあります。
  • フォームデータの保存/更新時、Map<String, Object> のJsonString形式をパラメータとしてフォーム内のデータを渡します。keyはコンポーネントID、Objectはコンポーネントの値です。各コンポーネントの値形式は以下の通りです：
コンポーネントタイプデータ形式データ形式備考
単行入力文字列"danhang"
複数行入力文字列"duohang"
数値入力数値1
単一選択文字列"オプション1"
ドロップダウン単一選択文字列"オプション1"
複数選択文字列配列["オプション1", "オプション2"]
ドロップダウン複数選択文字列配列["オプション1", "オプション2"]
日付コンポーネントタイムスタンプ日付コンポーネント
カスケード日付文字列配列["1514736000000", "1517328000000"]。 終了時間のみある場合、["", "1517328000000"]最初が開始時間のタイムスタンプ文字列、2つ目が終了時間のタイムスタンプ文字列
人員検索ボックス文字列配列["xxxxx", "yyyyy"]
市選択文字列配列["110000", "110100", "110101"]最初は必ず都道府県ID、2番目は都市ID、3番目は区ID。
部署選択文字列配列["1123456"]["xxx"] 内は部署ID
カスケード選択文字列配列["part", "part_b"]カスケード順に従って配列に順次入れます
画像アップロード文字列配列[{"downloadUrl":"ファイルダウンロードアドレス", "name": "ファイル名"}]
添付コンポーネント文字列配列[{"downloadUrl":"ファイルダウンロードアドレス", "name": "ファイル名"}]
サイクルリンクコンポーネント文字列配列[{"link":"http://www.aliwork.com", "text":"宜搭"}]
サブフォームJSONARRAY[{"textField_jcr0069m": "danhang1"}, {"textField_jcr0069m": "danhang2"}] (textField_jcr0069m はサブフォームのシングルラインコンポーネントID)サブフォームには複数のレコードがあるため、JSONARRAYを使用します。各レコードは多数のコンポーネント値を含むため、JSONObjectで各コンポーネントに対応する値を保存します
手書き署名文字列"画像アドレス"
  • 完全なフォームデータ形式は以下の通りです：
{
  "textField_jcr0069m": "danhang",
  "textareaField_jcr0069n": "duohang",
  "numberField_jcr0069o": 1,
  "radioField_jcr0069p": "オプション1",
  "selectField_jcr0069q": "オプション1",
  "checkboxField_jcr0069r": [
    "オプション2",
    "オプション3"
  ],
  "multiSelectField_jcr0069s": [
    "オプション2",
    "オプション3"
  ],
  "dateField_jcr0069t": 1516636800000,
  "cascadeDate_jcr0069u": [
    "1514736000000",
    "1517328000000"
  ],
  "employeeField_jcr0069x": [
    "xxxxx"
  ],
  "citySelectField_jcr0069y": [
    "110000",
    "110100",
    "110101"
  ],
  "departmentField_jcr0069z": 1123456,
  "cascadeSelectField_jcr006a0": [
    "part",
    "part_b"
  ],
  "imageField_l096bb9l": [
    {
      "name": "クレヨンしんちゃん.jpg",
      "previewUrl": "https://img.alicdn.com/imgextra/i4/O1CN01DD8OQA1Lnay0fZRs3_!!6000000001344-0-tps-640-452.jpg",
      "downloadUrl": "https://img.alicdn.com/imgextra/i4/O1CN01DD8OQA1Lnay0fZRs3_!!6000000001344-0-tps-640-452.jpg",
      "size": 19039,
      "url": "https://img.alicdn.com/imgextra/i4/O1CN01DD8OQA1Lnay0fZRs3_!!6000000001344-0-tps-640-452.jpg"
    }
  ],
  "attachmentField_jna1lvyb": [
    {
      "downloadUrl": "https://www.aliwork.com/fileHandle?appType=default_tianshu_app&fileName=edd07ca9-1d2e-44b5-98fe-c1e16202f90d.txt&instId=&type=download",
      "name": "test.txt",
      "previewUrl": "https://www.aliwork.com/inst/preview?appType=default_tianshu_app&fileName=test.txt&fileSize=4&downloadUrl=edd07ca9-1d2e-44b5-98fe-c1e16202f90d.txt",
      "url": "https://www.aliwork.com/fileHandle?appType=default_tianshu_app&fileName=edd07ca9-1d2e-44b5-98fe-c1e16202f90d.txt&instId=&type=download",
      "ext": "txt"
    }
  ],
  "tableField_jcr006a1": [
    {
      "cascadeDate_jcr006aa": [
        "1514736000000",
        "1517328000000"
      ],
      "cascadeSelectField_jcr006ae": [
        "product",
        "product_a"
      ],
      "checkboxField_jcr006a7": [
        "オプション1",
        "オプション2",
        "オプション3"
      ],
      "citySelectField_jcr006ac": [
        "120000",
        "120100",
        "120102"
      ],
      "dateField_jcr006a9": 1517328000000,
      "departmentField_jcr006ad": ["1123456"],
      "employeeField_jcr006ab": [
        "yyyyy",
        "xxxxx"
      ],
      "multiSelectField_jcr006a8": [
        "オプション1",
        "オプション2",
        "オプション3"
      ],
      "numberField_jcr006a4": 2,
      "radioField_jcr006a5": "オプション2",
      "selectField_jcr006a6": "オプション3",
      "textField_jcr006a2": "サブフォームのシングルライン",
      "textareaField_jcr006a3": "サブフォームのマルチライン"
    }
  ],
	"digitalSignatureField_kt3nh972": "https://tianshu-vpc.oss-cn-shanghai.aliyuncs.com/5e03f863-dd39-4f62-ba9b-497af2c9ad9f.png"
}

コンポーネント値による条件検索、コンポーネント値形式説明​

  • フォーム内の各コンポーネントには一意のIDがあります（ページデザイナーのコンポーネント右側の高度パネルで一意識別子を確認できます）。各コンポーネントの検索形式は異なります。現在検索をサポートしているフォームコンポーネントには、シングルライン、マルチライン、数字、単一選択、ドロップダウン単一選択、複数選択、ドロップダウン複数選択、日付、日付間隔、人員検索ボックス、地域選択、部署選択、カスケード選択、サブフォームコンポーネントがあります。
  • 検索時、各コンポーネントの検索条件を表すためにMap<String, Object>形式を使用します。keyはコンポーネントID、Objectはコンポーネントの検索値です。各コンポーネントの検索タイプと値形式は以下の通りです
コンポーネントタイプデータ形式データ形式備考
単行入力文字列"danhang"曖昧検索
複数行入力文字列"duohang"曖昧検索
数値入力文字列配列["1", "10"]範囲検索。最初が最小値、2番目が最大値
単一選択文字列"オプション1"精度検索
ドロップダウン単一選択文字列"オプション1"
複数選択文字列配列["オプション2"]配列検索。検索値は複数選択値のサブセットである必要があります
ドロップダウン複数選択文字列配列["オプション2"]配列検索。 検索値は複数選択値のサブセットである必要があります
日付コンポーネント文字列配列["1514736000000", "1517414399000"]範囲検索。最初が日付開始のタイムスタンプ、2番目が日付終了のタイムスタンプ。
日付間隔配列[["1514736000000", "1517414399000"], ["1514736000000", "1517414399000"]]範囲検索。最初の配列は日付間隔開始の検索範囲。2番目の配列は日付間隔終了の検索範囲。
人員検索ボックス文字列配列["xxxxx", "yyyyy"]["xxxxx", "yyyyyy"] 精度一致。値は完全一致する必要があり、社員番号の順序も一致する必要があります。
市選択文字列配列["110000", "110100", "110101"]["110000", "110100", "110101"] 配列検索。検索値は都市値のサブセットである必要があります。また、市IDがあれば、都道府県IDが必要です。区IDがあれば、都道府県IDと市IDが必要です。
部署選択数値1123456精度一致
カスケード選択文字列配列["part", "part_b"]配列検索。市選択の制限条件と一致しています。
サブフォームコンポーネント文字列"danhang"曖昧検索。サブフォーム下の値は大きなテキストであり、検索では曖昧検索を使用します
  • 完全な例
{
  "textField_jcr0069m": "danhang",
  "textareaField_jcr0069n": "duohang",
  "numberField_jcr0069o": ["1", "10"],
  "radioField_jcr0069p": "オプション1",
  "selectField_jcr0069q": "オプション1",
  "checkboxField_jcr0069r": ["オプション2"],
  "multiSelectField_jcr0069s": ["オプション2", "オプション3"],
  "dateField_jcr0069t": [1514736000000, 1517414399000],
  "cascadeDate_jcr0069u": [
    [1514736000000, 1517414399000],
    [1514736000000, 1517414399000]
  ],
  "employeeField_jcr0069x": ["xxxxx"],
  "citySelectField_jcr0069y": ["110000", "110100", "110101"],
  "departmentField_jcr0069z": ["1123456"],
  "cascadeSelectField_jcr006a0": ["part", "part_b"],
  "tableField_jcr006a1": "サブフォームデータ"
}

フローインスタンス詳細オブジェクト形式説明​

  • フォーム内の各コンポーネントには一意のIDがあります（ページデザイナーのコンポーネント右側の高度パネルで一意識別子を確認できます）。各コンポーネントの検索形式は異なります。現在検索をサポートしているフォームコンポーネントには、シングルライン、マルチライン、数字、単一選択、ドロップダウン単一選択、複数選択、ドロップダウン複数選択、日付、日付間隔、人員検索ボックス、地域選択、部署選択、カスケード選択、サブフォームコンポーネントがあります。
  • 検索時、各コンポーネントの検索条件を表すためにMap<String, Object>形式を使用します。keyはコンポーネントID、Objectはコンポーネントの検索値です。各コンポーネントの検索タイプと値形式は以下の通りです
フィールド説明例備考
actionersフローインスタンスの現在のタスク実行者[{"userId": "workno", "name":{"zh_CN": "user_zh_name", "type": "i18n"}}]フローが完了し、実行者がいない場合、このフィールドは空です
processInstanceIdインスタンスID"f30233fb-72e1-4af4-8cb8-c7e0ea9ee530"一意
formUuidフローフォームIDFORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3
processCodeフローコードTPROC--EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ4
titleインスタンスタイトルxxxxが発行したフローあなたの言語環境に応じて、対応するタイトルを返します
instanceStatusインスタンス状態RUNNING
approvedResultフロー終了時の審査結論agreeagree -> 通過 disagree -> 拒否
originator文字列配列[{"name":{"zh_CN": "user_zh_name", "type": "i18n"}, "userId": "workno"}]
dataフォームデータ参考付録4- 返却値としてのフォームデータの形式説明
  • 完全なデータ形式のデモ
{
  "result": {
    "data": {
      "actioners": [
        {
          "name": {
            "pureEn_US": "xxx",
            "en_US": "xxx",
            "zh_CN": "xxx",
            "type": "i18n"
          },
          "userId": "xxx"
        }
      ],
      "processInstanceId": "f30233fb-72e1-4af4-8cb8-c7e0ea9ee530",
      "formUuid": "FORM-EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ3",
      "data": {
        "numberField_jcr0069o": 1,
        "multiSelectField_jcr0069s": ["オプション3", "オプション2"],
        "textareaField_jcr0069n": "duohang",
        "employeeField_jcr0069x": ["xxxx"],
        "departmentField_jcr0069z": "情報xxxプラットフォーム",
        "cascadeDate_jcr0069u": ["1514736000000", "1517328000000"],
        "cascadeSelectField_jcr006a0": ["part", "part_b"],
        "tableField_jcr006a1": [
          {
            "departmentField_jcr006ad": "情報xxx",
            "cascadeDate_jcr006aa": ["1514736000000", "1517328000000"],
            "selectField_jcr006a6": "オプション3",
            "citySelectField_jcr006ac": ["天津", "天津市", "河東区"],
            "radioField_jcr006a5": "オプション2",
            "employeeField_jcr006ab": ["yyyyy", "xxxxxx"],
            "dateField_jcr006a9": 1517328000000,
            "textField_jcr006a2": "サブフォームのシングルライン",
            "textareaField_jcr006a3": "サブフォームのマルチライン",
            "cascadeSelectField_jcr006ae": ["product", "product_a"],
            "numberField_jcr006a4": 2,
            "checkboxField_jcr006a7": ["オプション1", "オプション3", "オプション2"],
            "multiSelectField_jcr006a8": ["オプション1", "オプション3", "オプション2"]
          }
        ],
        "selectField_jcr0069q": "オプション1",
        "citySelectField_jcr0069y": ["北京", "北京市", "東城区"],
        "checkboxField_jcr0069r": ["オプション3", "オプション2"],
        "textField_jcr0069m": "danhang",
        "radioField_jcr0069p": "オプション1",
        "dateField_jcr0069t": 1516636800000
      },
      "processCode": "TPROC--EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ4",
      "originator": {
        "name": {
          "pureEn_US": "xxx",
          "en_US": "xxxx",
          "zh_CN": "xxx",
          "type": "i18n"
        },
        "userId": "xxxx"
      },
      "title": "xxxが発行したフロー",
      "instanceStatus": "RUNNING"
    },
    "totalCount": 1,
    "currentPage": 1
  },
  "success": true
}

返却値としてのフォームデータの形式説明​

返却値としてのフォームデータ形式は付録1 保存/更新 フォームデータ形式説明と基本的には一致しています。違いは以下の通りです：

  • エントリ時、地域コンポーネントの値は["都道府県ID", "市ID", "区ID"]です。返却値時には["都道府県名", "都市名", "地域名"]になります。
  • 単一選択、ドロップダウン単一選択、複数選択、ドロップダウン複数選択は国際化されています。返却値時は、渡されたlanguageパラメータに応じて、対応するデータ値を返します。

フォームインスタンス詳細オブジェクト形式説明​

フィールド説明例備考
gmtModified最終修正時間2018-01-24 11:22:01
formUuidフォームIDFORM-EF6Y93URN24F1SCX15VA2P918LPEIJ2H3UFORCJ1
originator発行者詳細[{"name":{"zh_CN": "user_zh_name", "type": "i18n"}, "userId": "workno"}]
formDataフォームデータ詳細TPROC--EF6Y4G8WO2FN0SUB43TDQ3CGC3FMFQ1G9400RCJ4参考付録4- 返却値としてのフォームデータの形式説明
  • 完全なデータ形式のデモ
{
  "result": {
    "gmtModified": "2018-01-24 11:22:01",
    "formUuid": "FORM-EF6Y93URN24F1SCX15VA2P918LPEIJ2H3UFORCJ1",
    "formInstId": "FINST-EF6Y93URN2F02S745LTMW2D2G4WVDS16O17ISCJ0",
    "formData": {
      "numberField_jcr0069o": 1,
      "multiSelectField_jcr0069s": ["オプション3", "オプション2"],
      "textareaField_jcr0069n": "duohang",
      "employeeField_jcr0069x": ["xxxx"],
      "departmentField_jcr0069z": "xxxx",
      "cascadeDate_jcr0069u": ["1514736000000", "1517328000000"],
      "cascadeSelectField_jcr006a0": ["part", "part_b"],
      "tableField_jcr006a1": [
        {
          "departmentField_jcr006ad": "xxxx",
          "cascadeDate_jcr006aa": ["1514736000000", "1517328000000"],
          "selectField_jcr006a6": "オプション3",
          "citySelectField_jcr006ac": ["天津", "天津市", "河東区"],
          "radioField_jcr006a5": "オプション2",
          "employeeField_jcr006ab": ["xxxxxx", "yyyyyy"],
          "dateField_jcr006a9": 1517328000000,
          "textField_jcr006a2": "サブフォームのシングルライン",
          "textareaField_jcr006a3": "サブフォームのマルチライン",
          "cascadeSelectField_jcr006ae": ["product", "product_a"],
          "numberField_jcr006a4": 2,
          "checkboxField_jcr006a7": ["オプション1", "オプション3", "オプション2"],
          "multiSelectField_jcr006a8": ["オプション1", "オプション3", "オプション2"]
        }
      ],
      "selectField_jcr0069q": "オプション1",
      "citySelectField_jcr0069y": ["北京", "北京市", "東城区"],
      "checkboxField_jcr0069r": ["オプション3", "オプション2"],
      "textField_jcr0069m": "danhang",
      "radioField_jcr0069p": "オプション1",
      "dateField_jcr0069t": 1516636800000
    },
    "originator": {
      "name": {
        "pureEn_US": "userEnglishName",
        "en_US": "userEnglishName",
        "zh_CN": "userName",
        "type": "i18n"
      },
      "userId": "xxxx"
    }
  },
  "success": true
}
この文書は機械翻訳により生成されています。翻訳により生じた齟齬や相違点は拘束力を持たず、コンプライアンスや執行目的において法的効力はありません。
© DingTalk (Singapore) Private Limited