DokumentationDynamic Media Image Production System-API

getAssetsByName getassetsbyname

Last update: Mon Dec 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Admin

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

Syntax

Autorisierte Benutzertypen section-754790841ea242d5ae8bedd587d7730e

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Gibt nur Assets zurück, auf die der Benutzer Lesezugriff hat.

Parameter section-f64e93c127b84a29aa3bf2fdd916cca9

Eingabe (getAssetsByNameParam)

Name
Typ
Erforderlich
Beschreibung
companyHandle
xsd:string
Ja
Der Griff zum Unternehmen.
accessUserHandle
xsd:string
Nein
Bietet Zugriff für andere Benutzende. Nur für Administratoren verfügbar.
accessGroupHandle
xsd:string
Nein
Wird zum Filtern nach einer bestimmten Gruppe verwendet.
nameArray
:StringArray
Ja
Array von Asset-Namen zum Abrufen.
assetTypeArray
:StringArray
Nein
Array von Asset-Typen, die für abgerufene Assets zulässig sind.
excludeAssetTypeArray
:StringArray
Nein
Array von Asset-Typen, die für abgerufene Assets ausgeschlossen sind.
assetSubTypeArray
:StringArray
Nein
Array von Asset-Untertypen, die für abgerufene Assets zulässig sind.
rictSubTypeCheck
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
:StringArray
Nein
Enthält eine Liste der Felder und Unterfelder, die in der Antwort enthalten sind.
excludeFieldArray
:StringArray
Nein
Enthält eine Liste der Felder und Unterfelder, die von der Antwort ausgeschlossen sind.

Ausgabe (getAssetsByNameReturn)

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

Beispiele section-3b7447398e574c88aeaf8ca159cc78dd

Dieses Code-Beispiel gibt zwei Bildtyp-Assets zurück.

Anfrage

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