コンテンツにスキップ

$p.apiGroupsDelete

概要

AjaxのPOSTリクエストにより、グループを削除します。

構文

JavaScript
$p.apiGroupsDelete ({
    id: <削除対象のグループID>,
    done: <任意の処理>,
    fail: <任意の処理>,
    always: <任意の処理>
});

パラメータ

パラメータ名 説明 必須
id 削除対象のグループID ○
done API通信成功 ○
fail API通信失敗 -
always 完了時 -

使用例

JavaScript
$p.apiGroupsDelete({
    id: 123,
    done: function (data) {
        console.log(data);
        console.log('グループ情報の削除に成功しました。');
    },
    fail: function () {
        console.log('グループ情報の削除に失敗しました。');
    },
    always: function () {
        console.log('グループ情報の削除が完了しました。');
    }
});

戻り値

API通信成功時に「done」に渡される値は、API「グループ削除」のレスポンスと同じ形式です。

サンプルコード

1. プロジェクトグループの作成・メンバー反映・廃止を申請レコードで行う

このサンプルは「$p.apiGroupsCreate」のサンプルコードにあります。

関連情報