ExecuteAction

指定アクションを実行する

Description

指定アクションを実行してアイテム更新し、コメントを追記します。

Method

POST

Request Format

/api/v0/applications/:app-id/datastores/:datastore-id/items/action/:item-id/:action-id

Payload

Content-Type : application/json

{
  "comment": "test-comment",
  "return_item_result": true, // true指定すると、更新されたアイテム情報を返します
  "item": {
      "5e256923aeae8e212cb2e03b": "value", // text tyepe
      "58bbaa27fbfcba6098746061": "5d4c058baa39555618ac9e98", // select type
      "58bbaa27fbfcba6098746067" : [ "58bbaa27fbfcba6098746015", "596e2327fbfcbab8283dde09"]  // checkbox type
  },
  "rev_no":8,　//現在のrevison番号
  "ensure_transaction": false, // true指定すると、関連アイテムの処理中一つでもエラーが発生するとすべての登録がロールバックされます。デフォルトはfalseであり、成功されたrelated_itemの登録・更新は反映され、エラーがあった明細についてはエラーメッセージが返されます。
  "exec_children_post_procs": true, // true指定すると、related_ds_itemsに対してもActionScript(POST ActionScript)やWebhookの実行、自動リンクの生成、通知処理の実行を行います。注意）related_ds_itemsに対してPRE ActionScriptは実行されません。
  "as_params": {"param1": "value1", "param2": "value2",}, // ActionScriptへ任意のObject（型形式は自由）を渡すことができます。PRE/POST ActionScript双方に渡されます。 ActionScript内からは、 `data.as_params`として参照可能です。
  "is_sync_related_items": true, // true指定すると、related_ds_itemsの登録順がpayloadで指定した並びになります（同期実行となるため処理が少し遅くなります）
  "related_ds_items" : {
      "関連データストアID_1" : [{ },{ },{ },{ }... ] ,
      "関連データストアID_2" : [{ },{ },{ },{ }... ] 
    },  // 関連するデータストアの新規・更新・削除を指定  詳細は以下を参照
 "realtime_auto_link": true, // true指定すると、自動リンクの作成を同期実行する（同期実行となるため処理が少し遅くなります）
 "access_key_updates": {　　// アクセスキーを指定
      "overwrite": true,　 // アクセスキーを上書き保存（デフォルトはfalse：既存のキーに追加する）
      "ignore_action_settings": true, // アクションに設定された公開設定を利用しない（このPayloadで指定したキーのみを付与する）
      "apply_related_ds": true,  // related_ds_itemsに指定したアイテムにも同様の設定を利用する（個別に指定した場合はその内容が実行されます）
      "groups_to_publish": ["GROUP1", "GROUP2"],  // group display_idを指定（実行ユーザが保持するキーのみ指定可能）
      "roles_to_publish": ["ADMIN", "MEMBER"], // role display_idを指定（実行ユーザが保持するキーのみ指定可能）
      "users_to_publish": ["607c2a25844887b6855a12a9", "5f25956428dc5c55b463bc77" ] // user_idを指定（ワークスペース内に存在するuser_idを指定可能）
  }
}

トランザクション機能を利用するには、ensure_transaction : trueを指定します。この場合、関連アイテムの処理中一つでもエラーが発生するとすべての登録がロールバックされます。デフォルトはfalseであり、成功されたrelated_itemの登録・更新は反映され、エラーがあった明細についてはエラーメッセージが返されます。

関連するアイテムも同時に更新する場合は、以下フォーマットで指定

    "related_ds_items" : { // 関連するデータストアの新規・更新・削除を指定
      "RELATED_DS_1" : [
        {
          "operation" : 1,  // new
          "link_to_parent": true,  // 親Itemとのデータリンクを作成する（双方のリンクが作成される） default: false(親→指定したi_idへのリンクのみ)
          "action_id" : "", // new actionID　※省略可 (省略するとデフォルトの新規アクションが利用される)
          "item": {
            "FIELD_ID1" : "data",
            "FIELD_ID2" : "data",
            "FIELD_ID3" : "data",
            "FIELD_ID4" : "data",
          },
          "access_key_updates": {　　// アクセスキーを個別に指定
            "overwrite": true,　 // アクセスキーを上書き保存（デフォルトはfalse：既存のキーに追加する）
            "ignore_action_settings": true, // アクションに設定された公開設定を利用しない（このPayloadで指定したキーのみを付与する）
            "apply_related_ds": true,  // related_ds_itemsに指定したアイテムにも同様の設定を利用する
            "groups_to_publish": ["GROUP1", "GROUP2"],  // group display_idを指定（実行ユーザが保持するキーのみ指定可能）
            "roles_to_publish": ["ADMIN", "MEMBER"], // role display_idを指定（実行ユーザが保持するキーのみ指定可能）
            "users_to_publish": ["607c2a25844887b6855a12a9", "5f25956428dc5c55b463bc77" ] // user_idを指定（ワークスペース内に存在するuser_idを指定可能）
          },
          "related_ds_items" : {  // related_ds_itemsをネストさせることも可能。（同一Datastoreの複数ネストさせることは不可）
              "関連データストアID_3" : [{ },{ },{ },{ }... ] ,
          }
        },{
          "operation" : 2,  // update
          "action_id" : "Update2", // update actionID　※省略可 (省略するとデフォルトの更新アクションが利用される)
          "link_to_parent": true,  // 親Itemとのデータリンクを作成する（双方のリンクが作成される） default: false(親→指定したi_idへのリンクのみ)
          "i_id" : "58bbaa27fbfcba609874aaa3f", // 対象アイテムID
          "item": {
            "FIELD_ID1" : "data",
            "FIELD_ID3" : "data"
          },
          "access_key_updates": {　　// アクセスキーを個別に指定
            "overwrite": true,　 // アクセスキーを上書き保存（デフォルトはfalse：既存のキーに追加する）
            "ignore_action_settings": true, // アクションに設定された公開設定を利用しない（このPayloadで指定したキーのみを付与する）
            "apply_related_ds": true,  // related_ds_itemsに指定したアイテムにも同様の設定を利用する
            "groups_to_publish": ["GROUP1", "GROUP2"],  // group display_idを指定（実行ユーザが保持するキーのみ指定可能）
            "roles_to_publish": ["ADMIN", "MEMBER"], // role display_idを指定（実行ユーザが保持するキーのみ指定可能）
            "users_to_publish": ["607c2a25844887b6855a12a9", "5f25956428dc5c55b463bc77" ] // user_idを指定（ワークスペース内に存在するuser_idを指定可能）
          },
        },{
          "operation" : 3,  // delete
          "i_id" : "58bbaa27fbfcba609874aqr45", // 対象アイテムID
        },{
          "operation" : 11,  // add link :リンクを作成
          "link_to_parent": true,  // 親Itemとのデータリンクを作成する（双方のリンクが作成される） default: false(親→指定したi_idへのリンクのみ)
          "i_id" : "58bbaa27fbfcba609874aqr46", // 対象アイテムID
        },{
          "operation" : 12,  // remove link :リンクを削除
          "i_id" : "58bbaa27fbfcba609874aqr47", // 対象アイテムID
        },{
          // 関連する複数アイテムを指定可能。sample 省略
        },{
          // 関連する複数アイテムを指定可能。sample 省略
        },{
          // 関連する複数アイテムを指定可能。sample 省略
        }
      ]
      "RELATED_DS_2" : [ // sample 省略 ]
      "RELATED_DS_3" : [ // sample 省略 ]
    }

更新用Valueはchanges プロパティへ配列で指定することも可能です。

"changes": [
    {
      "id": "5e256923aeae8e212cb2e03b",
      "value": "value"
    },
    {
      "id": "58bbaa27fbfcba6098746061", 
      "value": "5d4c058baa39555618ac9e98",
    },
    {
      "id": "58bbaa27fbfcba6098746067",
      "value": [ "58bbaa27fbfcba6098746015", "596e2327fbfcbab8283dde09"],  // checkbox type
    },
  ]

Request Sample

POST https://api.xxx.com/api/v0/applications/:app-id/datastores/:datastore-id/items/action/:item-id/:action-id

Response Sample

null

Payload に "return_item_result": true　を指定した場合、登録されたアイテム情報がもどる

{
  "item": {
    // 登録されたアイテム情報がもどる（関連アイテムの詳細は含まれない）
    // 関連データがある場合は、linksに対象アイテムのdatastore_idとitem_id群が返却される
    "links": [
      {
        "d_id": "62bc37653f0b074bc12f5cfa",
        "i_ids": [
            "62bc376ba678e4e7ee1da6b6"
        ]
      },
      {
        "d_id": "62bc3942a678e4e7ee1da6cf",
        "i_ids": [
            "63454d2fd4958dbd8b63f990",
            "63454d2fd4958dbd8b63f98c"
        ]
      }
    ]
  }
}

Errors

エラー発生時、以下のようにエラーが返ります。
エラーコードはこちらを参照ください。

itemのリビジョン整合エラー

Itemを更新するためには、リクエストpayload内にrev_noを与えるか、is_force_update: trueを渡して強制アップデートを指示する必要があります。他のユーザーが先に該当Itemを更新していた場合、Revisionエラーが発生します。

HTTP 409 または 200( Related datastoreのみ本エラーが発生した場合は、errorメッセージを含む200が返ります)
{
    "error": [
        {
            "description": "item:601978f228dc5c3c64e5b895(d_id:5f38b0afaa395581685afdf6) has rev_no:14 but specified rev_no:0",
            "error": "Revision number mismatch",
            "error_code": "ITEM_REV_CONFLICT",
            "error_level": "ERROR",
            "reference_id": "601978f228dc5c3c64e5b895"
        }
    ],
    "history_id": "609e6016f3d4d143baa13070",
    "item": {
        // (itemの値)
    },
    "item_id": "609e6015f3d4d143baa1306e"
}

ActionID指定エラー

指定したデータベース、アクションIDが見つからない場合は以下のエラーとなります。
例えばログインユーザーのカレントワークスペースが異なるワークスペースを向いている場合、該当Actionが見つからず、本エラーとなることがあります。

{
    "error": "no available actions to create new item in the database. you should check settings or check if you are in your current workspace[ xxxxxxxxxxxxxxxxxx ]"
}

その他のエラー

※注意）ここより以下のエラーは、下位互換性維持のため、2021年7月以降に作成されたワークスペースのみエラーチェックが適用されます。それ以前のワークスペースに対してこのチェックを有効化したい場合は、個別に有効化するため、Hexabase社へお問合せください。

Actionの権限エラー

該当するActionに対する権限がない場合、以下のエラーとなります。

HTTP403
{
    "error": "invalid action_id or has no privileges to the user or current item status. a_id:MoveToAssigned(5f38a11caa39556e74845a43) d_id:SAMPLEDB(5f38a11baa395581685afdb4)",
    "error_code": "NO_PRIVILEGES"
}

対象Itemが見つかりません

更新対象のItemIDに誤りがある、または、他のユーザーが該当Itemを削除した場合、このエラーとなります。

HTTP404
{
    "description": "item is not found for i_id:601e5c3728dc5c447cfbc3b1",
    "error": "target item was not found",
    "error_code": "NOT_FOUND"
}

入力データに不備

関連するItemに対して、実行したAcitonに対する入力データに不備がある場合、error配列内にエラーが返ります。
INVALID_VALUE (required field for this action) 必須入力フィールドにデータが入力されていません。
NO_PRIVILEGES（not arrowed to update this field for this action）入力時に非表示、または入力不可に設定されている項目にデータを入力しようとしました。

HTTP 400
{
    "error_code": "INVALID_VALUE"
    "description": "input validation error. datastore:TODO-SAMPLE action:(default edit) ",
    "error": [
        {
            "description": "d_id: 611e67c9720bbecb02013e64 field: Category(f_id:611e67c9485729c3fde24788), value: (not specified)",
            "error": "required field for this action 611e67ca485729c3fde2479f (show,update,required)=(true,true,true)",
            "error_code": "INVALID_VALUE",
            "error_level": "ERROR"
        },
        {
            "description": "d_id: 6121fccd27ef72f577ad28bc field: Number(f_id:6121fd24170986e3a7cfcb9b), value: 111",
            "error": "not arrowed to update this field for this action 6121fcce170986e3a7cfcb98 (show,update,required)=(false,false,false)",
            "error_code": "NO_PRIVILEGES",
            "error_level": "ERROR"
        }
    ]
}

ExecuteAction

Description

Method

Request Format

Payload

Request Sample

Response Sample

Errors

itemのリビジョン整合エラー

ActionID指定エラー

その他のエラー

Actionの権限エラー

対象Itemが見つかりません

関連Itemが見つかりません

入力データに不備

関連Itemへの入力データに不備

Description​

Method​

Request Format​

Payload​

Request Sample​

Response Sample​

Errors​

itemのリビジョン整合エラー​

ActionID指定エラー​

その他のエラー​

Actionの権限エラー​

対象Itemが見つかりません​

関連Itemが見つかりません​

入力データに不備​

関連Itemへの入力データに不備​

Description

Method

Request Format

Payload

Request Sample

Response Sample

Errors

itemのリビジョン整合エラー

ActionID指定エラー

その他のエラー

Actionの権限エラー

対象Itemが見つかりません

関連Itemが見つかりません

入力データに不備

関連Itemへの入力データに不備