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

UpdateAutoNumber

自動採番項目更新API

Description

  • データストア内の特定フィールドに対する、自動採番値を更新します

関連情報 > 採番APIによる自動採番について

Method

POST

Request URL Format

/api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/autonum

URL Params

app-id      : アプリケーションID(Hexabase画面から入力したIDを指定)
datastore-id : データストアID(Hexabase画面から入力したIDを指定)
field-id : 自動採番項目のフィールドID(Hexabase画面から入力したIDを指定)

Payload

Content-Type : application/json

{
"auto_num": 1, // 必須
"branch_key": "branch-" // (任意)指定することでGetAutoNumberでbranch_keyを設定した自動採番値を対象とする
}

Request URL Sample

POST https://api.xxx.com/api/v0/applications/APP_NAME/datastores/DS_NAME/fields/Branch-No/autonum

Response Description

  • 更新した値と自動採番フィールドの設定にフォーマットされた形式を返す

Request Sample

例1

  • auto_numのみ指定

Payload

{
"auto_num": 1
}

Response

{
"has_error": false,
"result": {
"number": "000000001",
"value": 1
}
}
対象アイテムfield-idauto_numbranch_key
Branch-No2NULL
Branch-No3""
Branch-No1branch-
  • branch_keyを指定しない場合は自動採番フィールド表示時の値が更新対象となります

例2

  • branch_key""(空)と指定

Payload

{
"auto_num": 1,
"branch_key": ""
}

Response

{
"has_error": false,
"result": {
"number": "000000001",
"value": 1
}
}
対象アイテムfield-idauto_numbranch_key
Branch-No2NULL
Branch-No3""
Branch-No1branch-
  • branch_key""(空)で指定した場合はGetAutoNumberでbranch_keyを指定しない場合の値が更新対象となります

例3

  • branch_keybranch-と指定

Payload

{
"auto_num": 1,
"branch_key": "branch-"
}

Response

{
"has_error": false,
"result": {
"number": "branch-000000001",
"value": 1
}
}
対象アイテムfield-idauto_numbranch_key
Branch-No2NULL
Branch-No3""
Branch-No1branch-

Errors

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

該当Fieldが見つかりません

  • 指定したデータストア、フィールドIDに誤りがあるか、見つからない場合、エラーとなります。
HTTP 400(Bad Request)

{
"errors": [
{
"description": "invalid fieldID in the datastore",
"error": "could not find field for AutoNum1",
"error_code": "INVALID_PARAMS",
"error_level": "ERROR",
"reference_id": "f_id:AutoNum1"
}
],
"has_error": true,
"result": null
}
  • 指定したフィールドはAutoNumber型である必要があります。そうでない場合、エラーとなります。
HTTP 400(Bad Request)
{
"errors": [
{
"description": "invalid fieldID in the datastore",
"error": "specified field[600a839528dc5c3e9cd7e7de] is not the auto number type",
"error_code": "INVALID_PARAMS",
"error_level": "ERROR",
"reference_id": "f_id:600a839528dc5c3e9cd7e7de"
}
],
"has_error": true,
"result": null
}
  • 指定したbranch_keyが存在しない場合、エラーとなります。
HTTP 400(Bad Request)
{
"errors": [
{
"description": "error update auto_number",
"error": "could not find field for f_id: 63ce11b063c4431d4443e880 branch_key: branch-",
"error_code": "INVALID_PARAMS",
"error_level": "ERROR",
"reference_id": "f_id:63ce11b063c4431d4443e880"
}
],
"has_error": true,
"result": null
}