SearchAssets searchassets

Suche nach Assets basierend auf Ihren angegebenen Kriterien.

Syntax

searchAssets: Über section-4ad74f12eb754768bf85bd235a7e25f0

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 anhand des Namens.

Antwortgröße

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

Ergebnisdateigröße mit responseFieldArray oder excludeFieldArray begrenzen

Begrenzen Sie die Größe Ihres Datensatzes mit den responseFieldArray- oder excludFieldArray. Diese Parameter tragen dazu bei, die Speichernutzung und Bandbreite zu reduzieren und die Reaktionszeiten des Servers zu verbessern.

Autorisierte Benutzertypen section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Der Benutzer muss über Lesezugriff verfügen, um Assets zurückzugeben.

Parameter section-49aabc0600764f55a8b7017d86ded44f

Eingabe (searchAssetsParam)

Name
Typ
Erforderlich?
Beschreibung
companyHandle
xsd:string
Ja
Das Handle für das Unternehmen mit den Assets, die Sie suchen möchten.
accessUserHandle
xsd:string
Nein
Ermöglicht es Administratoren, als ein anderer Benutzer zu arbeiten.
accessGroupHandle
xsd:string
Nein
Ermöglicht es Administratoren, als Teil einer anderen Gruppe zu arbeiten.
Ordner
xsd:string
Nein
Der Stammpfad für die Suche nach Assets. Wenn ausgelassen, wird der Stammordner des Unternehmens verwendet.
includeSubfolders
xsd:Boolean
Nein
Auf " true“ , um Unterordner zu durchsuchen.
publishState
xsd:string
Nein
Publish State Choice.
trashState
xsd:string
Nein
Auswahl des Papierkorb-Status. Der Standardwert ist NotInTrash.
conditionMatchMode
xsd:string
Nein

Auswahl der Such-Match-Modi zum Kombinieren der Ergebnisse KeywordArray,

conditionMatchMode

systemFieldConditionArray und metadataConditionArray. Die Standardeinstellung ist MatchAll.

SchlüsselwortArray
:StringArray
Nein

Hinweis: Veralteter Parameter. Es wird empfohlen, es nicht zu verwenden.

Ein Zeichenfolgen-Array von abzugleichenden Schlüsselwörtern.

systemFieldMatchMode
xsd:string
Nein

Auswahl der Such-Übereinstimmungsmodi zum Kombinieren systemFieldCondition Übereinstimmungen. Die Standardeinstellung ist MatchAll

.

systemFieldConditionArray
:SystemFieldConditionArray
Nein
Das Array von Systemfeldbedingungen.
tagMatchMode
xsd:string
Nein
Suche Übereinstimmungsmodi Zeichenfolgenkonstanten. Der Standardwert lautet MatchAll.
TagConditionArray
:TagConditionArray
Nein

Ein Array von Tag-Feld-Sucheigenschaften.

Prädikate werden gemäß der Einstellung tagMatchMode kombiniert und dann mit beliebigen Begriffen in SchlüsselwortArray, systemFieldConditionArray und metadataConditionArray gemäß der Einstellung conditionMatchMode kombiniert.

metadataMatchMode
xsd:string
Nein
Suchen Sie nach Übereinstimmungsmodi zum Kombinieren Übereinstimmungen mit . Die Standardeinstellung ist MatchAll.
metadataConditionArray
:MetadataConditionArray
Nein
Das Array von Suchbedingungen für Metadatenfelder.
assetTypeArray
:StringArray
Nein
Array von Asset-Typen, die bei der Suche einbezogen werden sollen.
excludeAssetTypeArray
:StringArray
Nein
Array von Asset-Typen, die von der Suche ausgeschlossen werden sollen.
assetSubTypeArray
:StringArray
Nein
Eine Liste mit Namen von Untertypen, nach denen gefiltert werden soll.
rictSubTypeCheck
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 Nebenprodukt-Assets, die während der Aufnahme eines primären Assets generiert werden, wie z. B. ausgelöste PDF-Seitenbilder, aus den Suchergebnissen ausgeschlossen. Der Standardwert ist „false“.
excludeByproductArray
:ExcludeByproductArray
Nein
Array von Bedingungen zur Erzeugung von Nebenprodukt-Assets, die aus Suchergebnissen ausgeschlossen werden sollen. Wenn 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 an zurückzugebenden Ergebnissen
resultsPage
xsd:int
Nein
Gibt die zurückzugebende Ergebnisseite basierend auf der Seitengröße recordsPerPage .
sortBy
xsd:string
Nein
Auswahl von Asset-Sortierfeldern.
sortDirection
xsd:string
Nein
Auswahl der Sortierrichtung.
responseFieldArray
:StringArray
Nein
Enthält eine Liste von Feldern und Unterfeldern , die in die Antwort aufgenommen werden sollen.
excludeFieldArray
:StringArray
Nein
Enthält eine Liste der Felder und Unterfelder zum Ausschluss aus der Antwort.

Ausgabe (searchAssetsReturn)

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

Beispiele section-725484cc09b54772a838ad2cc930b94b

In diesem Code-Beispiel wird nach Bild-Assets gesucht, die zu einem bestimmten Unternehmen gehören. Die Antwort wird zur Vereinfachung gekürzt.

Anfrage

<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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681