getAssetsByName

Gibt Assets basierend auf einem Array von Asset-Namen zurück.

Syntax

Autorisierte Benutzertypen

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
HINWEIS

Gibt nur Assets zurück, auf die der Benutzer Lesezugriff hat.

Parameter

Eingabe (getAssetsByNameParam)

Name Typ Erforderlich Beschreibung
companyHandle xsd:string Ja Der Handle für das Unternehmen.
accessUserHandle xsd:string Nein Bietet Zugriff als anderer Benutzer. Nur für Administratoren verfügbar.
accessGroupHandle xsd:string Nein Wird zum Filtern nach einer bestimmten Gruppe verwendet.
nameArray Typen:StringArray Ja Array von Asset-Namen, die abgerufen werden sollen.
assetTypeArray Typen:StringArray Nein Array von Asset-Typen, die für abgerufene Assets zulässig sind.
excludeAssetTypeArray Typen:StringArray Nein Array von Asset-Typen, die für abgerufene Assets ausgeschlossen sind.
assetSubTypeArray Typen:StringArray Nein Array von Asset-Untertypen, die für abgerufene Assets zulässig sind.
strictSubTypeCheck xsd:boolean Nein

Wenn true und assetSubTypeArray nicht leer ist, werden nur Assets zurückgegeben, deren Untertypen sich in assetSubTypeArray befinden.

Wenn false, werden Assets ohne definierten Untertyp einbezogen.

Der Standardwert ist false.

responseFieldArray Typen:StringArray Nein Enthält eine Liste von Feldern und Unterfeldern, die in der Antwort enthalten sind.
excludeFieldArray Typen:StringArray Nein Enthält eine Liste von Feldern und Unterfeldern, die von der Antwort ausgeschlossen sind.

Ausgabe (getAssetsByNameReturn)

Name Typ Erforderlich Beschreibung
*assetArray* types:AssetArray Nein Array von Assets, die den Filterkriterien entsprechen.

Beispiele

Dieses Codebeispiel gibt zwei Bildtyp-Assets zurück.

Anforderung

<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>

Antwort

<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>

Auf dieser Seite