searchAssets

Suche nach Assets basierend auf Ihren angegebenen Kriterien.

Syntax

searchAssets: Info

searchAssets ist die primäre Methode zum Abrufen von IPS-Assets. Diese Methode wird für verschiedene Zwecke verwendet, z. B. zum Durchsuchen der Ordnerhierarchie oder zum Suchen eines bestimmten Assets nach Namen.

Antwortgröße

searchAssets gibt bis zu 1000 Assets in einem einzelnen Aufruf zurück. Um bis zu 10.000 Assets pro Aufruf zurückzugeben, beschränken Sie die Antwortdaten auf eine Untergruppe der Felder totalRows, name, handle, type und subType. Um größere Sets zurückzugeben, richten Sie die Paging-Umgebung mit dem Parameter resultPage ein.

Limit Result File Size with responseFieldArray or excludeFieldArray

Begrenzen Sie die Größe Ihres Datensatzes mit den Parametern responseFieldArray oder excludFieldArray . Diese Parameter helfen, die Speicherbelegung und Bandbreite zu reduzieren und die Reaktionszeiten der Server zu verbessern.

Autorisierte Benutzertypen

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

HINWEIS

Der Benutzer muss über Lesezugriff verfügen, um Assets zurückgeben zu können.

Parameter

Eingabe (searchAssetsParam)

Name	Typ	Erforderlich?	Beschreibung
companyHandle	xsd:string	Ja	Der Handle für das Unternehmen mit den Assets, die Sie suchen möchten.
accessUserHandle	xsd:string	Nein	Damit können Administratoren als andere Benutzer arbeiten.
accessGroupHandle	xsd:string	Nein	Damit können Administratoren als Teil einer anderen Gruppe arbeiten.
Ordner	xsd:string	Nein	Der Stammpfad für die Suche nach Assets. Wenn dieser Wert weggelassen wird, wird der Stammordner des Unternehmens verwendet.
includeSubfolders	xsd:boolean	Nein	Auf true setzen, um Unterordner zu suchen.
publishState	xsd:string	Nein	Auswahl des Veröffentlichungsstatus.
trashState	xsd:string	Nein	Auswahl des Papierkorbsstatus. Der Standardwert ist NotInTrash.
conditionMatchMode	xsd:string	Nein	Auswahl der Suchübereinstimmungsmodi für die Kombination der Ergebnisse von keywordArray, conditionMatchMode systemFieldConditionArray und metadataConditionArray. Der Standardwert ist MatchAll.
keywordArray	Typen:StringArray	Nein	Hinweis: Veraltete Parameter. Es wird empfohlen, es nicht zu verwenden. Ein Zeichenfolgen-Array mit Suchbegriffen, die abgeglichen werden sollen.
systemFieldMatchMode	xsd:string	Nein	Auswahl der Suchübereinstimmungsmodi für die Kombination von systemFieldCondition Übereinstimmungen. Der Standardwert ist MatchAll .
systemFieldConditionArray	Typen:SystemFieldConditionArray	Nein	Das Array der Systemfeldbedingungen.
tagMatchMode	xsd:string	Nein	Zeichenfolgenkonstanten "Suchabgleich"verwendet. Der Standardwert ist MatchAll.
tagConditionArray	Typen:TagConditionArray	Nein	Ein Array von Tag-Feld-Sucheigenschaften. Eigenschaften werden gemäß der Einstellung tagMatchMode kombiniert und dann mit allen Begriffen in keywordArray, systemFieldConditionArray und metadataConditionArray gemäß conditionMatchMode -Einstellung.
metadataMatchMode	xsd:string	Nein	Suchübereinstimmungsmodi zum Kombinieren von metadataCondition Übereinstimmungen. Der Standardwert ist MatchAll.
metadataConditionArray	Typen:MetadataConditionArray	Nein	Das Array der Suchbedingungen für Metadatenfelder.
assetTypeArray	Typen:StringArray	Nein	Array von Asset-Typen, die in die Suche einbezogen werden sollen.
excludeAssetTypeArray	Typen:StringArray	Nein	Array von Asset-Typen, die von der Suche ausgeschlossen werden sollen.
assetSubTypeArray	Typen:StringArray	Nein	Eine Liste mit Namen von Untertypen, nach denen gefiltert werden soll.
strictSubTypeCheck	xsd:boolean	Nein	Wenn true und assetSubTypeArray nicht leer ist, werden nur Assets zurückgegeben, deren Untertypen sich in assetSubTypeArray befinden. Wenn false (Standard), werden Assets ohne definierten Untertyp zurückgegeben.
excludeByproducts	xsd:boolean	Nein	Wenn "true", werden bei der Erfassung eines primären Assets generierte Nebenprodukt-Assets, z. B. gerippte PDF-Seitenbilder, aus den Suchergebnissen ausgeschlossen. Der Standardwert ist „false“.
excludByproductArray	Typen:ExcludeByproductArray	Nein	Array von Bedingungen für die Asset-Generierung, die von den Suchergebnissen ausgeschlossen werden sollen. Falls vorhanden, überschreibt dieser Parameter die Einstellung excludeByproducts .
projectHandle	xsd:sting	Nein	Handle eines Projekts, das die zu suchenden Assets enthält.
recordsPerPage	xsd:int	Nein	Maximale Anzahl der zurückzugebenden Ergebnisse.
resultsPage	xsd:int	Nein	Gibt die Seite der zurückzugebenden Ergebnisse basierend auf der Seitengröße recordsPerPage an.
sortBy	xsd:string	Nein	Auswahl der Asset-Sortierfelder.
sortDirection	xsd:string	Nein	Auswahl der Sortierrichtung.
responseFieldArray	Typen:StringArray	Nein	Enthält eine Liste von Feldern und Unterfeldern, die in die Antwort aufgenommen werden sollen.
excludeFieldArray	Typen:StringArray	Nein	Enthält eine Liste von Feldern und Unterfeldern, die aus der Antwort ausgeschlossen werden können.

Ausgabe (searchAssetsReturn)

Name	Typ	Erforderlich	Beschreibung
``totalRows``	`xsd:int`	Nein	Anzahl der Zeilen, die eine Suche zurückgibt, wenn Datensätze pro Seite nicht beschränkt sind.
``assetArray``	`types:AssetArray`	Nein	Assets, die von der Suche zurückgegeben werden.

Beispiele

In diesem Codebeispiel wird nach Bild-Assets gesucht, die zu einem bestimmten Unternehmen gehören. Die Antwort wird aus Gründen der Kürze abgeschnitten.

Anforderung

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

Antwort

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