Function useEntityListingService

Returns {
    downloadFile: (params: DownloadFileParams) => void;
    executeSearch: (
        params: EntityListingSearchParam,
    ) => Promise<WebApiResponse<EntityListingSearchResult>>;
    getEntityProperties: (
        __namedParameters: GetEntityPropertiesParams,
    ) => Promise<WebApiResponse<EntityPropertyResponse>>;
    loadDefinition: (
        __namedParameters: LoadEntityListingDefinitionParameter,
    ) => Promise<
        ViewInitializationDataResponse<
            EntityListingDefinition,
            Record<string, never>,
        >,
    >;
    validateCondition: (
        params: EntityListingSearchParam,
    ) => Promise<WebApiResponse<ValidateConditionResponse>>;
}

• downloadFile: (params: DownloadFileParams) => void

  ファイルダウンロードを実行します。 ActionMappingのSTREAMレスポンスを利用し、Formサブミットでダウンロードします。

• executeSearch: (
      params: EntityListingSearchParam,
  ) => Promise<WebApiResponse<EntityListingSearchResult>>

  検索を実行します。

• getEntityProperties: (
      __namedParameters: GetEntityPropertiesParams,
  ) => Promise<WebApiResponse<EntityPropertyResponse>>

  Entityのプロパティツリーを取得します。 バックエンドのWebAPIはPOSTメソッドでパラメータをJSON形式で受け付けます。

• loadDefinition: (
      __namedParameters: LoadEntityListingDefinitionParameter,
  ) => Promise<
      ViewInitializationDataResponse<
          EntityListingDefinition,
          Record<string, never>,
      >,
  >

  EntityListing定義をロードします。

• validateCondition: (
      params: EntityListingSearchParam,
  ) => Promise<WebApiResponse<ValidateConditionResponse>>

  検索条件をバリデーションします。 バックエンドレスポンス: status='SUCCESS'|'ERROR_PARAMETER', data=boolean, error=string