local_products
ローカルプロダクト（製品）情報を取得するためのエンドポイントです。
| エンドポイント | local_products |
| 機能 | SIDfm プロダクト取得 |
| 実装バージョン | 2.8.0 |
| 認証 | 有り |
| HTTPメソッド | GET/POST |
パラメータ
| 入力値 | 機能 | 入力値の型 | デフォルト値 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| q[api_key] |
パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 |
String | なし | ||||||
| q[offset] | 取得するデータの先頭位置を指定します。 | Number | 0 | ||||||
| q[per_page] |
1～200 の値で、1 度に取得するデータの数を指定します。指定した値が 1～200 を超えている場合は 10 として扱われます。 ※全データ数の指定は不可です。 |
Number | 10 | ||||||
| q[order] |
一覧データのソート順を指定します。
下記の文字列に _asc を付けると昇順、_desc を付けると降順となります。(例: name_asc)
|
String | name_asc | ||||||
| q[filters][name] | 取得するプロダクトを名前で絞り込みます。 | String | なし | ||||||
| q[filters][version] | 取得するプロダクトをバージョンで絞り込みます。 | Number | なし | ||||||
| q[filters][is_support_end] | 取得するプロダクトをサポート終了状況で絞り込みます。true, false で指定します。 | Boolean | なし | ||||||
| q[filters][flg_enable] | 取得するプロダクトを有効判定フラグで絞り込みます。true, false で指定します。 | Boolean | なし |
レスポンス
| key | value の内容 | value の型 |
|---|---|---|
| success | 認証の成否 | Boolean |
| response | エラー等の補足情報 | Hash |
| total_size | 取得した履歴の数 | Number |
| products | プロダクト一覧 | Array<Hash> |
| name | プロダクト名 | String |
| is_support_end | プロダクトのサポート終了状況 | Boolean |
| flg_enable | 有効判定フラグ | Boolean |
| priority | 優先度 | Number |
| eol_date | プロダクトのサポート終了日 | String |
| versions | バージョン一覧 | Array<Hash> |
| fullname | バージョン名 | String |
| is_support_end | プロダクトのサポート終了状況 | Boolean |
| flg_enable | バージョンが有効か無効か | Boolean |
| priority | 優先度 | Number |
| release_date | リリース日 | String |
| support_date | サポート開始日 | String |
| eol_date | サポート終了日 | String |
レスポンス例
{
"success": true,
"response": {},
"total_size": 1,
"products": [
{
"name": "てすとプロダクト",
"is_support_end": false,
"flg_enable": true,
"priority": 1,
"eol_date": "2023/10/26",
"versions": {
"fullname": "1.1.1",
"is_support_end": false,
"flg_enable": true,
"priority": 1,
"release_date": "2021/10/26",
"support_date": "2022/10/26",
"eol_date": "2023/10/26"
}
}
}