組織削除
目的
組織を削除します。
基本項目
| 項目 |
値 |
備考 |
| url |
/api/admin/organization/:farm_id |
|
| メソッド |
DELETE |
|
| content-type |
application/json |
|
| 文字コード |
utf-8 |
|
リクエスト
ヘッダ
| ヘッダ名 |
値 |
| X-fn-gene-api-idtoken |
Firebase ID Token |
パラメータ(URL)
| パラメータ名 |
名称 |
型 |
サイズ |
| farm_id |
組織ID |
string |
10byte |
パラメータ(クエリ)
なし
ボディ
なし
レスポンス
レスポンスステータス
| HTTPステータス |
内容 |
| 200 |
削除成功 |
| 401 |
認証エラー |
| 404 |
対象がない |
| 500 |
その他エラー |
ボディ(JSON)
| パラメータ名 |
名称 |
型 |
サイズ |
| farmid |
組織ID |
String |
10Byte |
| name |
組織名 |
String |
|
| description |
備考 |
String |
|
| url |
セールスフォースURL |
String |
|
| regist_date |
登録日時 |
Timestamp |
|
| deletion_date |
削除日時 |
Timestamp |
|
※削除された内容がレスポンスされます。
レスポンスサンプル
- Content-Type
Application/Json
{
"farmid": "sXpE1ckVhP",
"name": "東京牧場",
"description": "東京の牧場",
"url": "https://xxxxxxxxxxxxxxxxxxxx",
"regist_date": "2022-06-03T07:13:38.179Z",
"deletion_date": "2022-06-05T03:20:21.387Z"
}