DocumentatieDynamic Media Image Production System API

getAssetsByName getassetsbyname

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar
  • Beheerder

Retourneert elementen die zijn gebaseerd op een array met namen van elementen.

Syntaxis

Geautoriseerde gebruikerstypen section-754790841ea242d5ae8bedd587d7730e

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Hiermee worden alleen elementen geretourneerd waartoe de gebruiker leestoegang heeft.

Parameters section-f64e93c127b84a29aa3bf2fdd916cca9

Input (getAssetsByNameParam)

Naam
Type
Vereist
Beschrijving
companyHandle
xsd:tekenreeks
Ja
De handgreep aan het bedrijf.
accessUserHandle
xsd:tekenreeks
Nee
Biedt toegang als een andere gebruiker. Alleen beschikbaar voor beheerders.
accessGroupHandle
xsd:tekenreeks
Nee
Wordt gebruikt om te filteren op een specifieke groep.
nameArray
types:StringArray
Ja
Array met elementnamen die moeten worden opgehaald.
assetTypeArray
types:StringArray
Nee
Array met elementtypen die zijn toegestaan voor opgehaalde elementen.
excludeAssetTypeArray
types:StringArray
Nee
Array met elementtypen die zijn uitgesloten voor opgehaalde elementen.
assetSubTypeArray
types:StringArray
Nee
Array met elementsubtypen die zijn toegestaan voor opgehaalde elementen.
strictSubTypeCheck
xsd:Boolean
Nee

Indien true en assetSubTypeArray is niet leeg, alleen elementen waarvan de subtypen zich bevinden assetSubTypeArray worden geretourneerd.

Indien falseworden vervolgens elementen zonder gedefinieerd subtype opgenomen.

De standaardwaarde is false.

responseFieldArray
types:StringArray
Nee
Bevat een lijst met velden en subvelden die zijn opgenomen in het antwoord.
excludeFieldArray
types:StringArray
Nee
Bevat een lijst met velden en subvelden die zijn uitgesloten van de reactie.

Output (getAssetsByNameReturn)

Naam
Type
Vereist
Beschrijving
assetArray
types:AssetArray
Nee
Array met elementen die voldoen aan de filtercriteria.

Voorbeelden section-3b7447398e574c88aeaf8ca159cc78dd

Dit codevoorbeeld retourneert twee elementen van het afbeeldingstype.

Verzoek

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

Antwoord

<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