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

CreateGroup

新規グループを作成する

Description​

新規で、指定したグループの配下にグループを作成します。

Method​

POST

Request URL Format​

/api/v0/groups/:parent-group-id

URL Params​

"parent-group-id": 必須　指定したグループの配下に新規グループを作成

Payload​

Content-Type : application/json

{
  "name" : "グループ名",  // 必須
  "display_id": "グループID",　 // 必須
  "disable_ui_access": true | false // オプション。デフォルトfalse。true: Hexabase UIアクセス不可, false: Hexabase UIアクセス可能
}

Request URL Sample​

POST https://api.xxx.com/api/v0/groups/:parent-group-id

Response Sample​

{
    "group": {
        "access_key": "作成されたグループのアクセスキー",
        "created_at": "作成時間　年-月-日時刻",
        "display_id": "グループのDisplay_ID",
        "g_id": "作成されたグループID",
        "id": "作成されたグループID",
        "index": 0, //("int このグループレイヤーのindex位置")
        "is_root": false, //("bool グループツリー上最上位に位置される場合true")
        "name": "グループ名"
    },
    "groupTree_datastores_res": null　// ("配下にグループ有るかどうか")
}