ジョブ登録

目的

アルゴリズム処理を行うジョブの登録を行います。

基本項目

項目	値	備考
url	/api/admin/job
メソッド	POST
content-type	application/json
文字コード	utf-8

リクエスト

ヘッダ

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

パラメータ(URL)

なし

パラメータ(クエリ)

なし

ボディ(JSON)

パラメータ名	名称	型	サイズ
farmid	組織ID	string	10byte
engine_version	エンジンバージョン	string
pattern_id	パターンID	Number
job_date	管理日付	string

job_dateは、登録ジョブに関してなにかしら管理したい日付を記録できます。実際にこの日付を使って処理は行いません。あくまで備忘録な位置づけです。

{
    "farmid": "VfLgh1cBw7",
    "engine_version": "v002",
    "pattern_id": "1",
    "job_date": "2022-05-13"
}

レスポンス

レスポンスステータス

HTTPステータス	内容
201	JSON
400	リクエストBODYエラー
401	認証エラー
404	対象がない
500	その他エラー

ボディ(JSON)

パラメータ名	名称	型	サイズ
id	ジョブID	Number
job_date	管理日付	Date
farmid	組織ID	String
engine_version	エンジンバージョン	String
pattern_id	パターンID	Number
status	ジョブステータス	Number
regist_count	登録番号	Number
regist_date	ジョブ登録日時	Timestamp

※登録内容がレスポンスされます。

レスポンスサンプル

• Content-Type Application/Json

{
  "id": 122,
  "job_date": "2022-06-01",
  "farmid": "sXpE1ckVhP",
  "engine_version": "v002",
  "pattern_id": 1,
  "status": 0,
  "regist_count": 114,
  "regist_date": "2022-06-02T14:28:14.087Z"
}