DocumentatieDynamic Media Image Production System-API

searchAssets searchassets

Last update: Fri Aug 15 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar
  • Beheerder

Zoek naar activa die op uw gespecificeerde criteria worden gebaseerd.

Syntaxis

searchAssets: over section-4ad74f12eb754768bf85bd235a7e25f0

searchAssets is de primaire methode om IPS activa terug te winnen. Deze methode wordt gebruikt voor verschillende doeleinden, zoals het bladeren in de maphiërarchie of het zoeken naar een bepaald element op naam.

Grootte van de Reactie

searchAssets retourneert maximaal 1000 elementen in één aanroep. Als u maximaal 10.000 elementen per aanroep wilt retourneren, beperkt u de reactiegegevens tot een subset van de velden totalRows , name , handle , type en subType . Als u grotere sets wilt retourneren, stelt u paginering in met de parameter resultPage .

de Grootte van het ResultaatDossier van de Grens met responseFieldArray of excludeFieldArray

Beperk de grootte van de gegevensset met de parameters responseFieldArray of excludFieldArray . Deze parameters helpen geheugengebruik en bandbreedte te verminderen en kunnen de tijden van de serverreactie verbeteren.

Geautoriseerde gebruikerstypen section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
De gebruiker moet lees toegang hebben om activa terug te keren.

Parameters section-49aabc0600764f55a8b7017d86ded44f

Input (searchAssetsParam)

Naam
Type
Vereist?
Beschrijving
companyHandle
xsd:string
Ja
De handgreep aan het bedrijf met de activa u wilt zoeken.
accessUserHandle
xsd:string
Nee
Hiermee kunnen beheerders als een andere gebruiker werken.
accessGroupHandle
xsd:string
Nee
Laat beheerders als deel van een verschillende groep werken.
folder
xsd:string
Nee
Het hoofdpad voor het zoeken naar elementen. Als u deze waarde weglaat, wordt de hoofdmap van het bedrijf gebruikt.
includeSubfolders
xsd:boolean
Nee
Stel in op true om te zoeken in submappen.
publishState
xsd:string
Nee
Frame voor publiceren kiezen.
trashState
xsd:string
Nee
Kies de status Prullenbak. De standaardwaarde is NotInTrash .
conditionMatchMode
xsd:string
Nee

Keuze van de Wijzen van de Gelijke van het Onderzoek voor het combineren van resultaten van keywordArray ,

conditionMatchMode

systemFieldConditionArray , en metadataConditionArray . De standaardwaarde is MatchAll .

keywordArray
types:StringArray
Nee

Opmerking: Vervangen parameter. Het wordt aanbevolen het niet te gebruiken.

Een tekenreeks met overeenkomende trefwoorden.

systemFieldMatchMode
xsd:string
Nee

Keuze van Zoekmethoden om overeenkomsten met systemFieldCondition te combineren. De standaardwaarde is MatchAll

.

systemFieldConditionArray
types:SystemFieldConditionArray
Nee
De array van systeemveldomstandigheden.
tagMatchMode
xsd:string
Nee
Zoekmodi tekenreeksconstanten. De standaardwaarde is MatchAll .
tagConditionArray
types:TagConditionArray
Nee

Een array met zoekvoorspelling van tagvelden.

De voorspellingen worden gecombineerd volgens tagMatchMode plaatsen, en dan gecombineerd met om het even welke termijnen in keywordArray , systemFieldConditionArray , en metadataConditionArray volgens het conditionMatchMode plaatsen.

metadataMatchMode
xsd:string
Nee
Zoekmodi voor het combineren van overeenkomsten metadataCondition . De standaardwaarde is MatchAll .
metadataConditionArray
types:MetadataConditionArray
Nee
De array met zoekvoorwaarden voor metagegevensvelden.
assetTypeArray
types:StringArray
Nee
Array met elementtypen die in de zoekopdracht moet worden opgenomen.
excludeAssetTypeArray
types:StringArray
Nee
Array met elementtypen die moeten worden uitgesloten van zoekopdracht.
assetSubTypeArray
types:StringArray
Nee
Een lijst met subtypenamen waarop u wilt filteren.
strictSubTypeCheck
xsd:boolean
Nee
Als true en assetSubTypeArray niet leeg is, worden alleen elementen geretourneerd waarvan de subtypen zich in assetSubTypeArray bevinden. Als false (standaardwaarde), worden elementen zonder gedefinieerd subtype geretourneerd.
excludeByproducts
xsd:boolean
Nee
Indien waar (true), worden bijproducten die worden gegenereerd tijdens de opname van een primair element, zoals bijgesneden PDF-paginaafbeeldingen, uitgesloten van zoekresultaten. De standaardwaarde is false.
excludeByproductArray
types:ExcludeByproductArray
Nee
Array met voorwaarden voor het genereren van byteproducten om elementen uit te sluiten van zoekresultaten. Indien aanwezig, treedt deze parameter de excludeByproducts die plaatsen met voeten.
projectHandle
xsd:sting
Nee
Handle van een project dat de activa bevat aan onderzoek.
recordsPerPage
xsd:int
Nee
Maximumaantal resultaten dat moet worden geretourneerd.
resultsPage
xsd:int
Nee
Specificeert de pagina van resultaten om terug te keren, die op recordsPerPage paginagrootte wordt gebaseerd.
sortBy
xsd:string
Nee
Keuze van velden voor het sorteren van elementen.
sortDirection
xsd:string
Nee
Keuze van sorteerrichting.
responseFieldArray
types:StringArray
Nee
Bevat een lijst met velden en subvelden voor opname in de reactie.
excludeFieldArray
types:StringArray
Nee
Bevat een lijst met velden en subvelden die kunnen worden uitgesloten van de reactie.

Output (searchAssetsReturn)

Naam
Type
Vereist
Beschrijving
totalRows
xsd:int
Nee
Het aantal rijen dat een zoekopdracht retourneert wanneer records per pagina niet beperkt zijn.
assetArray
types:AssetArray
Nee
Assets dat de zoekopdracht retourneert.

Voorbeelden section-725484cc09b54772a838ad2cc930b94b

In dit codevoorbeeld wordt gezocht naar afbeeldingselementen die bij een bepaald bedrijf horen. De reactie is afgebroken voor de beknoptheid.

Verzoek

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

Reactie

<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