コンテンツにスキップ

組織情報取得

目的

指定した組織情報を取得します。

基本項目

項目 備考
url /api/admin/organization/:farmid
メソッド GET
content-type application/json
文字コード utf-8

リクエスト

ヘッダ

ヘッダ名
X-fn-gene-api-idtoken Firebase ID Token

パラメータ(URL)

パラメータ名 名称 サイズ 備考
farmid 開始 Number 任意

パラメータ(クエリ)

なし

ボディ(JSON)

なし

レスポンス

レスポンスステータス

HTTPステータス 内容
200 JSON
401 認証エラー
404 対象がない
500 その他エラー

ボディ(JSON)

パラメータ名 名称 サイズ
farmid 組織ID String 10Byte
name 組織名 String
description 備考 String
url セールスフォースURL String
latest_job_status 最終ジョブス処理テータス Number
regist_date 登録日時 Timestamp

レスポンスサンプル

  • Content-Type Application/Json
{
  "farmid": "sXpE1ckVhP",
  "name": "東京牧場",
  "description": "東京の牧場です",
  "url": "https://xxxxxxxxxxxxxxxxxxxx",
  "latest_job_status": null,
  "regist_date": "2022-06-03T07:13:38.179Z"
}