Skip to main content

GetNewActions

Get a list of newly created actions

Description​

  • Get a list of create new action available to the logged-in user.
  • When the "New" button on the list screen is clicked, a menu of new creation actions is displayed to the user, and so on.
  • Normally, only one New Create menu is available, however Hexabase supports several New Create actions.

Method​

GET

Request URL Format​

/api/v0/datastores/:datastore-id/new-action

URL Params​

datastore-id    : Datastore ID

Request Sample​

GET https://api.xxx.com/api/v0/datastores/59bf42550e2479186a6c6c70/new-action

Response Sample​

{
    "actions": [
        {
            "action_id": "5a2502f00e24792b67887200",  // Action ID
            "name": "新規作成", //Action name
            "display_order": 2,  // Display order of the menu ; sort order of the Action menu in Hexabase
            "crud_type": "1",  // Always returns 1 (new registration)
            "next_status_id": "5a2502f00e24792b678871f8"   ///Status ID to be transitioned after the action is executed
        }
    ]
}

Errors​

  • When an error occurs, an error is returned as follows.
  • Please refer here for error codes.

No corresponding Action found​

  • If the corresponding data store is not found or there is no ActionID available, an error will occurs.
HTTP 404 (Not Found)
{
    "code": 101,
    "error_code": "INVALID_PARAMS",
    "message": "new action is not found for 5f38a11baa395581685afdb"
}