アップロードキュー件数取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_system_que/count

リファレンス内容

件数取得について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

検索条件を複数指定した場合、全ての条件がかつ(AND)となります

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)	【指定してaccess_tokenの有効期限が切れた場合】正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます【省略してaccess_tokenの有効期限が切れた場合】出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
`wait_flag`	1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却	可能(省略時は1以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)	検索条件の値(WHERE句の値相当)	可能	例：商品マスタ検索でパラメータ：goods_id-like、値：”%-red”と指定した場合、商品コードが*-redの商品マスタを検索します

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`access_token_end_date`	access_tokenの有効期限切れ日時
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`refresh_token_end_date`	refresh_tokenの有効期限切れ日時
`count`	検索結果の件数

アップロードキュー

項目名	フィールド名	データ型	備考
アップロードキューID	`que_id`	数値型
機能名	`que_method_name`	文字列型	SYOHIN_KIHON_CSV:商品マスタCSVアップロード,MALL_SYOHIN_CSV_TO_MASTER:商品情報一括登録
店舗ID	`que_shop_id`	文字列型
アップロード名	`que_upload_name`	文字列型	SYOHIN_KIHON_QUE:商品マスタ予約アップロード,TENPO_SYOHIN:商品情報一括登録（モール商品履歴表示用）,SYOHIN_KIHON:商品情報一括登録（商品マスタ履歴表示用）,MALL_SYOHIN_CSV_TO_MASTER_SYOHIN_KIHON:商品情報一括登録（商品マスタ取込用）,PAGE_SYOHIN:商品情報一括登録（ページ管理履歴表示用）,NE_API:ネクストエンジンAPI
クライアントファイル名	`que_client_file_name`	文字列型	ユーザーがアップロードした時のファイル名。
ファイル名	`que_file_name`	文字列型	商品マスタCSV、モール商品CSV等
ステータス	`que_status_id`	数値型	2:全て処理成功、1:処理中、0:処理待ち、-1:処理失敗
メッセージ	`que_message`	文字列型	処理中の場合、進捗状況、処理失敗の場合は、エラーになった理由（メイン機能のアップロード履歴と同じ）。
削除フラグ	`que_deleted_flag`	文字列型
作成日	`que_creation_date`	日時型
最終更新日	`que_last_modified_date`	日時型
最終更新日	`que_last_modified_null_safe_date`	日時型	NULLの場合作成日
作成担当者ID	`que_creator_id`	数値型
作成担当者名	`que_creator_name`	文字列型
最終更新者ID	`que_last_modified_by_id`	数値型
最終更新者ID	`que_last_modified_by_null_safe_id`	数値型	NULLの場合作成者ID
最終更新者名	`que_last_modified_by_name`	文字列型
最終更新者名	`que_last_modified_by_null_safe_name`	文字列型	NULLの場合作成者名

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxx&refresh_token=xxxxxxxxxx' https://api.next-engine.org/api_v1_system_que/count

レスポンス

{
  "result": "success",
  "count": "172",
  "access_token": "xxxxx",
  "access_token_end_date": "2017-04-15 13:03:47",
  "refresh_token": "xxxxx",
  "refresh_token_end_date": "2017-04-17 13:03:47"
}

エラー

エラーコード

エンドポイント固有のエラーコードはありません。共通エラーコードはメッセージコード一覧を参照してください。