DocumentatieDynamic Media Image Production System API

searchAssets searchassets

Last update: Tue Mar 08 2022 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: Info 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.

Responsgrootte

searchAssets keert tot 1000 activa in één enkele vraag terug. Om tot 10.000 activa per vraag terug te keren, beperk de reactiegegevens tot een ondergroep van totalRows, name, handle, type, en subType velden. Als u grotere sets wilt retourneren, stelt u paginering in met de resultPage parameter.

Resultaatbestandsgrootte beperken met responseFieldArray of excludeFieldArray

Beperk de grootte van de gegevensset met de responseFieldArray of excludFieldArray parameters. 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:tekenreeks
Ja
De handgreep aan het bedrijf met de activa u wilt zoeken.
accessUserHandle
xsd:tekenreeks
Nee
Hiermee kunnen beheerders als een andere gebruiker werken.
accessGroupHandle
xsd:tekenreeks
Nee
Laat beheerders als deel van een verschillende groep werken.
map
xsd:tekenreeks
Nee
Het hoofdpad voor het zoeken naar elementen. Als deze wordt weggelaten, wordt de hoofdmap van het bedrijf gebruikt.
includeSubfolders
xsd:Boolean
Nee
Instellen op true naar submappen zoeken.
publishState
xsd:tekenreeks
Nee
De keuze van de publicatiestatus.
prullenbakState
xsd:tekenreeks
Nee
Kies de status Prullenbak. Standaard is NotInTrash.
conditionMatchMode
xsd:tekenreeks
Nee

Keuze uit zoekmodi om de resultaten van keywordArray,

conditionMatchMode

systemFieldConditionArray, en metadataConditionArray. Standaard is MatchAll.

keywordArray
types:StringArray
Nee

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

Een tekenreeks met overeenkomende trefwoorden.

systemFieldMatchMode
xsd:tekenreeks
Nee

Keuze van zoekmodi om te combineren systemFieldCondition overeenkomsten. Standaard is MatchAll

.

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

Een array met zoekvoorspelling van tagvelden.

Voorspellen worden gecombineerd op basis van de tagMatchMode en vervolgens gecombineerd met termen in keywordArray, systemFieldConditionArray, en metadataConditionArray volgens de conditionMatchMode instellen.

metadataMatchMode
xsd:tekenreeks
Nee
Zoekmodi voor combineren metadataCondition overeenkomsten. Standaard 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
Indien true en assetSubTypeArray is niet leeg, alleen activa waarvan de subtypes in assetSubTypeArray worden geretourneerd. Indien false (standaardwaarde), worden vervolgens activa zonder gedefinieerd subtype geretourneerd.
excludeByproducts
xsd:Boolean
Nee
Indien waar (true), worden bijproductelementen die worden gegenereerd tijdens de opname van een primair element, zoals afbeeldingen op pagina's met bijgesneden PDF, niet opgenomen in 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:posten
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
Hiermee geeft u de resultatenpagina op die u wilt retourneren, op basis van recordsPerPage paginaformaat.
sortBy
xsd:tekenreeks
Nee
Keuze van velden voor het sorteren van elementen.
sortDirection
xsd:tekenreeks
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.

Uitvoer (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
Elementen die 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>

Antwoord

<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