searchAssets

指定した条件に基づいてアセットを検索します。

構文

searchAssets:について

searchAssets は、IPSアセットを取得する主な方法です。この方法は、フォルダー階層を参照したり、特定のアセットを名前で検索したりする目的など、様々な目的で使用されます。

応答サイズ

searchAssets は、1回の呼び出しで最大1,000個のアセットを返します。1回の呼び出しにつき最大10,000個のアセットを返すには、応答データをtotalRowsnamehandletypesubTypeの各フィールドのサブセットに制限します。 より大きなセットを返すには、resultPageパラメーターでページングを設定します。

responseFieldArrayまたはexcludeFieldArrayを使用した結果ファイルのサイズの制限

responseFieldArrayまたはexcludFieldArrayパラメーターを使用してデータセットのサイズを制限します。 これらのパラメーターは、メモリの使用と帯域幅の削減に役立ち、サーバーの応答時間を向上させます。

許可されたユーザーの種類

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
メモ

アセットを返すには、読み取りアクセス権が必要です。

パラメータ

入力(searchAssetsParam)

名前 種類 必須? 説明
companyHandle xsd:string はい 検索するアセットを持つ会社へのハンドル。
accessUserHandle xsd:string いいえ 管理者は別のユーザーとして作業できます。
accessGroupHandle xsd:string いいえ 管理者は別のグループの一部として作業できます。
フォルダー xsd:string いいえ アセットを検索するためのルートパス。 省略した場合は、会社のルートフォルダーが使用されます。
includeSubfolders xsd:boolean いいえ サブフォルダーを検索するには、 trueに設定します。
publishState xsd:string いいえ 公開状態の選択。
trashState xsd:string いいえ ごみ箱状態の選択。 初期設定は NotInTrashです。
conditionMatchMode xsd:string いいえ

keywordArrayの結果を組み合わせるための検索一致モードの選択

conditionMatchMode

systemFieldConditionArray metadataConditionArray。初期設定は MatchAllです。

keywordArray types:StringArray いいえ

注意: 非推奨のパラメーター。 あなたはそれを使わないことをお勧めします。

一致するキーワードの文字列配列。

systemFieldMatchMode xsd:string いいえ

systemFieldConditionの一致を組み合わせるための検索一致モードの選択。 デフォルトは MatchAllです。

.

systemFieldConditionArray

types:SystemFieldConditionArray

いいえ システムフィールド条件の配列。
tagMatchMode xsd:string いいえ 検索一致モード文字列定数。 デフォルトは MatchAllです。
tagConditionArray 型:TagConditionArray[がた:TagConditionArray] いいえ

タグフィールド検索用述語の配列。

述語は、 tagMatchModeの設定に従って結合され、 の条件に従って keywordArray systemFieldConditionArray metadataConditionArray内の任意の用語と結合されます。モード設定。

metadataMatchMode xsd:string いいえ metadataConditionの一致を組み合わせるための一致モードを検索します。 初期設定は MatchAllです。
metadataConditionArray

型:MetadataConditionArray[たいぷ:MetadataConditionArray]

いいえ メタデータフィールドの検索条件の配列。
assetTypeArray types:StringArray いいえ 検索に含めるアセットタイプの配列。
excludeAssetTypeArray types:StringArray いいえ 検索から除外するアセットタイプの配列。
assetSubTypeArray types:StringArray いいえ フィルタリングの対象となるサブタイプ名のリスト。
strictSubTypeCheck xsd:boolean いいえ trueおよび assetSubTypeArrayが空でない場合は、サブタイプが assetSubTypeArrayに含まれるアセットのみが返されます。 false (デフォルト)の場合、サブタイプが定義されていないアセットが返されます。
excludeByproducts xsd:boolean いいえ trueの場合、PDFページの切り抜き画像など、プライマリアセットの取り込み中に生成された副産物アセットは、検索結果から除外されます。 初期設定は false。
excludByproductArray

types:ExcludeByproductArray

いいえ 検索結果から除外する副産物アセット生成条件の配列。 存在する場合、このパラメーターはexcludeByproducts設定を上書きします。
projectHandle xsd:sting いいえ 検索するアセットを含むプロジェクトのハンドル。
recordsPerPage xsd:int いいえ 返す結果の最大数。
resultsPage xsd:int いいえ recordsPerPageページサイズに基づいて、返す結果のページを指定します。
sortBy xsd:string いいえ アセット並べ替えフィールドの選択。
sortDirection xsd:string いいえ 並べ替え方向の選択。
responseFieldArray types:StringArray いいえ 応答に含めるフィールドとサブフィールドのリストが含まれます。
excludeFieldArray types:StringArray いいえ 応答から除外するフィールドとサブフィールドのリストが含まれます。

出力(searchAssetsReturn)

名前 種類 必須 説明
*totalRows* xsd:int いいえ ページあたりのレコード数に制限がない場合に検索で返される行数。
*assetArray* types:AssetArray いいえ 検索で返されるアセット。

このコードサンプルでは、特定の会社に属する画像アセットを検索します。 簡潔にするために応答は切り捨てられます。

リクエスト

<ns1:searchAssetsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:includeSubfolders>true</ns1:includeSubfolders>
   <ns1:assetTypeArray>
      <ns1:items>Image</ns1:items>
   </ns1:assetTypeArray>
</ns1:searchAssetsParam>

応答

<searchAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <totalRows>210</totalRows>
   <assetArray>
      <items>
         <assetHandle>24265|1|17061</assetHandle>
         <type>Image</type>
         <name>Autumn Leaves</name>
         ...
      </items>
    </assetArray>
</searchAssetsReturn>

このページ