組織リスト取得
目的
組織一覧を取得します。
基本項目
| 項目 |
値 |
備考 |
| url |
/api/admin/organizations |
|
| メソッド |
GET |
|
| content-type |
application/json |
|
| 文字コード |
utf-8 |
|
リクエスト
ヘッダ
| ヘッダ名 |
値 |
| X-fn-gene-api-idtoken |
Firebase ID Token |
パラメータ(URL)
なし
パラメータ(クエリ)
| パラメータ名 |
名称 |
型 |
サイズ |
備考 |
| search |
検索キーワード |
String |
|
任意(farmid,組織名,備考からテキスト検索) |
| from |
開始 |
Number |
|
任意 |
| to |
終了 |
Number |
|
任意 |
ボディ(JSON)
なし
レスポンス
レスポンスステータス
| HTTPステータス |
内容 |
| 200 |
JSON |
| 401 |
認証エラー |
| 404 |
対象がない |
| 500 |
その他エラー |
ボディ(JSON)
| パラメータ名 |
名称 |
型 |
サイズ |
| all_count |
総数 |
Number |
|
| match_count |
検索マッチ数 |
Number |
|
| organization_list |
組織リスト |
Array |
|
| farmid |
組織ID |
String |
10Byte |
| name |
組織名 |
String |
|
| description |
備考 |
String |
|
| url |
セールスフォースURL |
String |
|
| latest_job_status |
最終ジョブス処理テータス |
Number |
|
| regist_date |
登録日時 |
Timestamp |
|
レスポンスサンプル
- Content-Type
Application/Json
{
"all_count": "41",
"match_count": "3",
"organization_list": [
{
"farmid": "kNwBE5BEDfXnEOLvCoanGVnQfiO2",
"name": "藤本牧場",
"description": "fujimoto",
"url": "http://www.yahoo.co.jp",
"latest_job_status": null,
"regist_date": "2022-04-27T15:29:28.595Z"
},
{
"farmid": "kCuTQ2LjGeeK8NLEXhw98RNnPkv2",
"name": "影山牧場",
"description": "kageyama",
"url": "http://www.yahoo.co.jp",
"latest_job_status": 2,
"regist_date": "2022-04-27T15:29:28.455Z"
},
{
"farmid": "IZRFIOOT2Gc0Yxfs6ocj8eyNPMl1",
"name": "畠山牧場",
"description": "hatakeyama",
"url": "http://www.yahoo.co.jp",
"latest_job_status": null,
"regist_date": "2022-04-27T15:29:28.314Z"
}
]
}