Dokumentation Dynamic Media Image Production System-API

searchAssets searchassets

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:

Erstellt für:

Entwickler
Admin

Suche nach Assets basierend auf Ihren angegebenen Kriterien.

Syntax

searchAssets: Info 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 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 das Paging 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 section-9c4bc41bb8b4493982197eb13c7cdc55

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

NOTE

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

Parameter section-49aabc0600764f55a8b7017d86ded44f

Input (searchAssetsParam)

Name

Typ

Erforderlich?

Beschreibung

companyHandle

xsd:string

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.

folder

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

Publish-Statusauswahl.

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

types:StringArray

Nein

Hinweis: Veralteter 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 übereinstimmen. Der Standardwert ist MatchAll

systemFieldConditionArray

types:SystemFieldConditionArray

Nein

Das Array der Systemfeldbedingungen.

tagMatchMode

xsd:string

Nein

Zeichenfolgenkonstanten "Suchabgleich"verwendet. Der Standardwert ist MatchAll.

tagConditionArray

types: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äß der Einstellung conditionMatchMode kombiniert.

metadataMatchMode

xsd:string

Nein

Suchübereinstimmungsmodi zum Kombinieren von metadataCondition übereinstimmen. Der Standardwert ist MatchAll.

metadataConditionArray

types:MetadataConditionArray

Nein

Das Array der Suchbedingungen für Metadatenfelder.

assetTypeArray

types:StringArray

Nein

Array von Asset-Typen, die in die Suche einbezogen werden sollen.

excludeAssetTypeArray

types:StringArray

Nein

Array von Asset-Typen, die von der Suche ausgeschlossen werden sollen.

assetSubTypeArray

types:StringArray

Nein

Eine Liste mit Namen von Untertypen, nach denen gefiltert werden soll.

strictSubTypeCheck

xsd:boolean

Nein

Wenn true und assetSubTypeArray nicht leer sind, 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

types: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 von recordsPerPage an.

sortBy

xsd:string

Nein

Auswahl der Asset-Sortierfelder.

sortDirection

xsd:string

Nein

Auswahl der Sortierrichtung.

responseFieldArray

types:StringArray

Nein

Enthält eine Liste von Feldern und Unterfeldern, die in die Antwort aufgenommen werden sollen.

excludeFieldArray

types: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, das die Suche zurückgibt.

Beispiele section-725484cc09b54772a838ad2cc930b94b

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.

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