Skip to main content

CreateItem

CreateItem

新規アイテムを作成(DisplayIDの利用)

Description

新規アイテムを作成します(Hexabase画面から入力したIDを指定)

Method

POST

Request URL Format

/api/v0/applications/:app-id/datastores/:datastore-id/items/new

URL Params

app-id      : アプリケーションID(Hexabase画面から入力したIDを指定)
datastore-id : データストアID(Hexabase画面から入力したIDを指定)

Request URL Sample

POST https://api.xxx.com/api/v0/applications/APPNAME/datastores/DATABASEID/items/new

Payload

(例) Content-Type : application/json

{
"action_id": "NewAction2", // (省略可)省略すると、デフォルトで指定されている新規登録Actionにより、登録されます。 アクションの画面ID(display_id)または 内部ID(a_id)を指定可能です。
"item": {
"field_id": "登録データ",
"title": "タイトル",
"assignee": "担当者"
},
"return_item_result": true, // true指定すると、登録されたアイテム情報を返します
"return_display_id": true, // true指定すると、登録されたアイテム情報のkeyをdisplay_idで返します
"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_force_update": true, // 子供Item(related_ds_items)の更新に"rev_no"を指定しない場合、強制更新する
"is_sync_related_items": true, // true指定すると、related_ds_itemsの登録順がpayloadで指定した並びになります(同期実行となるため処理が少し遅くなります)
"related_ds_items" : {
"関連データストアID_1" : [{ },{ },{ },{ }... ] ,
"関連データストアID_2" : [{ },{ },{ },{ }... ]
}, // 関連するデータストアの新規・更新・削除を指定 詳細は以下を参照
 "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"
},
"related_ds_items" : { // related_ds_itemsをネストさせることも可能。(同一Datastoreの複数ネストさせることは不可)
"関連データストアID_3" : [{ },{ },{ },{ }... ]
}
},{
"operation" : 2, // update
"action_id" : "", // update actionID ※省略可 (省略するとデフォルトの更新アクションが利用される)
"link_to_parent": true, // 親Itemとのデータリンクを作成する(双方のリンクが作成される) default: false(親→指定したi_idへのリンクのみ)
"i_id" : "58bbaa27fbfcba609874aaa3f", // 対象アイテムID
"item": {
"FIELD_ID1" : "data",
"FIELD_ID3" : "data"
}
},{
"operation" : 3, // delete
"action_id" : "", // delete actionID ※省略可 (省略するとデフォルトの削除アクションが利用される)
"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 省略 ]
}

Response Sample

{
"error": null,
"history_id": "5d661782aa39559a80479492",
"item_id": "5a2647410e24792d87451e34",
"item": {
 // Payload に "return_item_result": true を指定した場合、登録されたアイテム情報を返却
 // Payload に "return_display_id": true を指定した場合、登録されたアイテム情報のkeyをdisplay_idで返却
},
"pre_result": { // 対象のアクションにプレスクリプトが登録されていて、結果があれば返却
"result": "OK" // ActionScriptのプレスクリプト実行結果を返却
},
"as_result": { // 対象のアクションにポストスクリプトが登録されていて、結果があれば返却
"result": "OK" // ActionScriptのポストスクリプト実行結果を返却(同期実行がオンの場合)
}
}

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

  • エラー発生時のエラー情報については、ExecuteActionのエラー説明部分を参照ください。
  • エラーコードはこちらを参照ください。