DokumentationDynamic Media Image Production System API

getAssetsByName getassetsbyname

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
  • Administratör

Returnerar resurser baserat på en array med resursnamn.

Syntax

Auktoriserade användartyper section-754790841ea242d5ae8bedd587d7730e

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Returnerar bara resurser som användaren har läsåtkomst till.

Parametrar section-f64e93c127b84a29aa3bf2fdd916cca9

Indata (getAssetsByNameParam)

Namn
Typ
Obligatoriskt
Beskrivning
companyHandle
xsd:string
Ja
Handtaget till företaget.
accessUserHandle
xsd:string
Nej
Ger åtkomst som en annan användare. Endast tillgängligt för administratörer.
accessGroupHandle
xsd:string
Nej
Används för att filtrera efter en viss grupp.
nameArray
typer:StringArray
Ja
Array med resursnamn som ska hämtas.
assetTypeArray
typer:StringArray
Nej
En array med resurstyper som tillåts för hämtade resurser.
excludeAssetTypeArray
typer:StringArray
Nej
Array med tillgångstyper som exkluderats för hämtade resurser.
assetSubTypeArray
typer:StringArray
Nej
Array med tillgångsundertyper som tillåts för hämtade resurser.
strictSubTypeCheck
xsd:boolesk
Nej

Om true och assetSubTypeArray inte är tomma returneras bara resurser vars undertyper finns i assetSubTypeArray .

Om värdet är false inkluderas resurser utan definierad undertyp.

Standardvärdet är false.

responseFieldArray
typer:StringArray
Nej
Innehåller en lista med fält och underfält som ingår i svaret.
excludeFieldArray
typer:StringArray
Nej
Innehåller en lista med fält och underfält som är exkluderade från svaret.

Utdata (getAssetsByNameReturn)

Namn
Typ
Obligatoriskt
Beskrivning
assetArray
types:AssetArray
Nej
En array med resurser som matchar filtervillkoren.

Exempel section-3b7447398e574c88aeaf8ca159cc78dd

Detta kodexempel returnerar två bildtypsobjekt.

Begäran

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

Svar

<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