Suche nach Assets basierend auf Ihren angegebenen Kriterien.
Syntax
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, begrenzen Sie die Antwortdaten auf eine Untergruppe der totalRows
, name
, handle
, type
und subType
-Felder. Um größere Sets zurückzugeben, richten Sie die Paging-Funktion mit der resultPage
Parameter.
Limit Result File Size with responseFieldArray or excludeFieldArray
Begrenzen Sie die Größe Ihres Datensatzes mit der responseFieldArray
oder excludFieldArray
Parameter. Diese Parameter helfen, die Speicherbelegung und Bandbreite zu reduzieren und die Reaktionszeiten der Server zu verbessern.
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
Der Benutzer muss über Lesezugriff verfügen, um Assets zurückgeben zu können.
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 | Legen Sie fest auf true , 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 systemFieldConditionArrayund 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 systemFieldCondition Treffer. 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. Die Kombination von Prädikaten erfolgt gemäß tagMatchMode und dann mit allen Begriffen in keywordArray, systemFieldConditionArrayund metadataConditionArray gemäß conditionMatchMode -Einstellung. |
metadataMatchMode | xsd:string | Nein | Suchübereinstimmungsmodi für die Kombination metadataCondition Treffer. 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 ist nicht leer, nur Assets, deren Untertypen in assetSubTypeArray zurückgegeben. 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 Ergebnisseite an, die zurückgegeben werden soll, basierend auf recordsPerPage Seitengröße. |
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. |
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>