getAssetsByName

最終更新日: 2022-03-08
  • 作成対象:
  • Developer
    Admin

アセット名の配列に基づいてアセットを返します。

構文

認証済みユーザータイプ

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

ユーザーが読み取りアクセス権を持つアセットのみを返します。

パラメータ

入力 (getAssetsByNameParam)

名前 種類 必須 説明
companyHandle xsd:string はい 会社への取り扱い。
accessUserHandle xsd:string いいえ 別のユーザーとしてアクセスを提供します。 管理者のみが使用できます。
accessGroupHandle xsd:string いいえ 特定のグループでフィルタリングするために使用します。
nameArray types:StringArray はい 取得するアセット名の配列。
assetTypeArray types:StringArray いいえ 取得したアセットで使用できるアセットタイプの配列。
excludeAssetTypeArray types:StringArray いいえ 取得したアセットに対して除外されたアセットタイプの配列。
assetSubTypeArray types:StringArray いいえ 取得したアセットに許可されるアセットのサブタイプの配列。
strictSubTypeCheck xsd:boolean いいえ

If true および assetSubTypeArray が空ではない場合、サブタイプが assetSubTypeArray が返されます。

If falseを指定した場合、サブタイプが定義されていないアセットが含まれます。

デフォルト値は false.

responseFieldArray types:StringArray いいえ 応答に含まれるフィールドとサブフィールドのリストが含まれます。
excludeFieldArray types:StringArray いいえ 応答から除外されたフィールドとサブフィールドのリストが含まれます。

出力 (getAssetsByNameReturn)

名前 種類 必須 説明
assetArray types:AssetArray いいえ フィルター条件に一致するアセットの配列。

このコードサンプルは、2 つのイメージタイプアセットを返します。

リクエスト

<getAssetsByNameParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <companyHandle>c|3</companyHandle>
   <nameArray>
      <items>B010</items>
      <items>IMG_0103</items>
   </nameArray>
   <assetTypeArray>
      <items>Image</items>
   </assetTypeArray>
</getAssetsByNameParam>

応答

<getAssetsByNameReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <assetArray>
      <items>
         <assetHandle>a|210</assetHandle>
         <type>Image</type>
         <name>B010</name>
         ...</items>
      <items>
         <assetHandle>a|189</assetHandle>
         <type>Image</type>
         <name>IMG_0103</name>
         ...
      </items>
   </assetArray>
</getAssetsByNameReturn>

このページ