検索¶

指定した条件で検索したマスタの検索結果を取得します。

リクエストボディに記載した検索条件のみ設定可能です。

HTTPリクエスト
リクエストボディ
レスポンスデータ

HTTPリクエスト ¶

POST /kaiden/v2/api/generic/master/search

リクエストボディ ¶

リクエストボディ情報の説明です。

プロパティ名論理名型設定デフォルト値説明

masterId マスタID string マスタIDを保持するマスタの場合、必須なし MasterBuilderのマスタIDを指定します。

extensionId マスタ拡張ID string 任意なし MasterBuilderをカスタマイズして、マスタ拡張IDを設定している場合、指定します。

gadgetClass ガジェットクラス string ガジェットクラスを保持するマスタの場合、必須なし GadgetBuilderのガジェットクラス「master」を指定します。

gadgetVariation ガジェットバリエーション string ガジェットバリエーションを保持するマスタの場合、必須なし GadgetBuilderのガジェットバリエーションを指定します。

json JSON object 任意なしマスタの検索条件をJSON形式で指定します。

json/searchOptions 検索条件設定 object 任意なし

検索条件設定に記載がない項目を指定した場合、無視されます。

設定した検索条件に合致する項目が検索対象のマスタに存在しない場合、無視されます。

json/searchOptions/

searchCriteriaCompany

検索基準会社 string 任意ログインユーザの現在の選択組織の会社コード

会社コードを指定します。

会社化特性のマスタの会社コードに一致するか判定します。

json/searchOptions/

searchCriteriaDate

検索基準日 string 任意現在日付 yyyy/mm/dd形式で指定します。

json/searchOptions/

searchCriteriaUser

検索基準ユーザ string 任意ログインユーザのユーザコードユーザコードを指定します。

json/searchOptions/

searchCriteriaLocale

検索基準ロケール string 任意ログインユーザの使用ロケールのロケールID

ロケールIDを指定します。

国際化特性のマスタのロケールIDに一致するか判定します。

json/searchOptions/

searchWithDisabled

無効データ対象有無 string 任意 true：無効なデータを検索対象に含む

期間化特性のマスタの場合、無効なデータを検索対象に含むかを指定可能です。

true：無効なデータを検索対象に含む

false：無効なデータを検索対象に含まない

json/searchOptions/

searchKeyword

検索キーワード string 任意なし

指定された語句を部分一致で検索します。

検索対象になる項目はマスタごとに異なりますので、各マスタの一覧検索用SQLを確認してください。

検索キーワードは、検索条件の「searchCriteriaKeyword」として使用されます。

json/sortKey ソート項目設定 array<object> 任意

検索対象のマスタの主キーの昇順

「{“項目名”:”ソート方法”},{“項目名”:”ソート方法”}…」の形式で指定します。

項目名には、MasterBuilderの項目設定の項目名（genericMasterSettings / items / item @ name）が指定可能です。

ソート方法には、「asc」、「desc」が指定可能です。

json/paging ページング情報設定 object 任意各項目を参照してください。

ページング情報設定が未設定、または未設定項目がある場合、各項目のデフォルト値を設定します。

ページング情報設定のいずれかの項目に「0」を指定した場合、全件取得します。

json/paging/pageNo ページNo string 任意 1 取得するページNoを指定します。(1始まり)

json/paging/pageSize 最大件数 string 任意 20 1ページ当たりの最大件数を指定します。

リクエストボディのjsonの設定例
{
    "searchOptions":{
        "searchCriteriaCompany":"comp_sample_01",
        "searchCriteriaDate":"2020/01/01",
        "searchCriteriaUser":"aoyagi",
        "searchCriteriaLocale":"ja",
        "searchWithDisabled":"true",
        "searchKeyword":"XXX"
    },
    "sortKey":[
        {"field1":"asc"},
        {"detail.field2":"desc"}
    ],
    "paging":{
        "pageNo":"1",
        "pageSize":"20"
    }
}

レスポンスデータ ¶

レスポンスデータはJSON情報を返却します。

レスポンスデータ例
{
    "statusCode":"200",
    "error":"false",
    "message":"XXX",
    "errorMessage":"XXX",
    "pageInfo":{
        "pageNo":"1",
        "totalPageNo":"3"
    },
    "data":[
        {"companyCd":"xxx", "id":"XXX"},
        {"companyCd":"xxx", "id":"YYY"}
    ]
}
解説

プロパティ名論理名型説明

statusCode 処理ステータス string

200：正常終了（検索結果あり）

204：正常終了（検索結果なし）

401：エラー終了（認可によりアクセスが拒否）

405：エラー終了（対象機能のAPI利用が不可）

500：エラー終了（401、405以外のエラーが発生）

error 処理結果 boolean

true：エラー終了

false：正常終了

message メッセージ string 処理結果が正常終了で、検索結果が0件の場合、設定されます。

errorMessage エラーメッセージ string 処理結果がエラー終了の場合、設定されます。

pageInfo ページ情報 object ページ情報

pageInfo/pageNo ページNo string 返却対象の検索結果のページNo

pageInfo/totalPageNo 合計ページ数 string 検索結果の合計ページ数

data 検索結果 array<object>

検索結果が「{“項目名”:”値”,”項目名”:”値”…},」の形式で設定されます。

各マスタの一覧検索用SQLを実行した際のSELECT文の列名に紐づくEntityに定義したフィールドが、検索結果の項目に設定されます。

目次

検索¶

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶

目次

プロパティ名	論理名	型	設定	デフォルト値	説明
masterId	マスタID	string	マスタIDを保持するマスタの場合、必須	なし	MasterBuilderのマスタIDを指定します。
extensionId	マスタ拡張ID	string	任意	なし	MasterBuilderをカスタマイズして、マスタ拡張IDを設定している場合、指定します。
gadgetClass	ガジェットクラス	string	ガジェットクラスを保持するマスタの場合、必須	なし	GadgetBuilderのガジェットクラス「master」を指定します。
gadgetVariation	ガジェットバリエーション	string	ガジェットバリエーションを保持するマスタの場合、必須	なし	GadgetBuilderのガジェットバリエーションを指定します。
json	JSON	object	任意	なし	マスタの検索条件をJSON形式で指定します。
json/searchOptions	検索条件設定	object	任意	なし	検索条件設定に記載がない項目を指定した場合、無視されます。設定した検索条件に合致する項目が検索対象のマスタに存在しない場合、無視されます。
json/searchOptions/ searchCriteriaCompany	検索基準会社	string	任意	ログインユーザの現在の選択組織の会社コード	会社コードを指定します。会社化特性のマスタの会社コードに一致するか判定します。
json/searchOptions/ searchCriteriaDate	検索基準日	string	任意	現在日付	yyyy/mm/dd形式で指定します。
json/searchOptions/ searchCriteriaUser	検索基準ユーザ	string	任意	ログインユーザのユーザコード	ユーザコードを指定します。
json/searchOptions/ searchCriteriaLocale	検索基準ロケール	string	任意	ログインユーザの使用ロケールのロケールID	ロケールIDを指定します。国際化特性のマスタのロケールIDに一致するか判定します。
json/searchOptions/ searchWithDisabled	無効データ対象有無	string	任意	true：無効なデータを検索対象に含む	期間化特性のマスタの場合、無効なデータを検索対象に含むかを指定可能です。 true：無効なデータを検索対象に含む false：無効なデータを検索対象に含まない
json/searchOptions/ searchKeyword	検索キーワード	string	任意	なし	指定された語句を部分一致で検索します。検索対象になる項目はマスタごとに異なりますので、各マスタの一覧検索用SQLを確認してください。検索キーワードは、検索条件の「searchCriteriaKeyword」として使用されます。
json/sortKey	ソート項目設定	array<object>	任意	検索対象のマスタの主キーの昇順	「{“項目名”:”ソート方法”},{“項目名”:”ソート方法”}…」の形式で指定します。項目名には、MasterBuilderの項目設定の項目名（genericMasterSettings / items / item @ name）が指定可能です。ソート方法には、「asc」、「desc」が指定可能です。
json/paging	ページング情報設定	object	任意	各項目を参照してください。	ページング情報設定が未設定、または未設定項目がある場合、各項目のデフォルト値を設定します。ページング情報設定のいずれかの項目に「0」を指定した場合、全件取得します。
json/paging/pageNo	ページNo	string	任意	1	取得するページNoを指定します。(1始まり)
json/paging/pageSize	最大件数	string	任意	20	1ページ当たりの最大件数を指定します。

プロパティ名	論理名	型	説明
statusCode	処理ステータス	string	200：正常終了（検索結果あり） 204：正常終了（検索結果なし） 401：エラー終了（認可によりアクセスが拒否） 405：エラー終了（対象機能のAPI利用が不可） 500：エラー終了（401、405以外のエラーが発生）
error	処理結果	boolean	true：エラー終了 false：正常終了
message	メッセージ	string	処理結果が正常終了で、検索結果が0件の場合、設定されます。
errorMessage	エラーメッセージ	string	処理結果がエラー終了の場合、設定されます。
pageInfo	ページ情報	object	ページ情報
pageInfo/pageNo	ページNo	string	返却対象の検索結果のページNo
pageInfo/totalPageNo	合計ページ数	string	検索結果の合計ページ数
data	検索結果	array<object>	検索結果が「{“項目名”:”値”,”項目名”:”値”…},」の形式で設定されます。各マスタの一覧検索用SQLを実行した際のSELECT文の列名に紐づくEntityに定義したフィールドが、検索結果の項目に設定されます。

目次

検索¶

HTTPリクエスト¶

リクエストボディ¶

レスポンスデータ¶

目次

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶