DokumentationDynamic Media Image Production System API

searchAssets searchassets

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

Skapat för:

  • Utvecklare
  • Administratör

Sök efter resurser baserat på dina angivna villkor.

Syntax

searchAssets: Om section-4ad74f12eb754768bf85bd235a7e25f0

searchAssets är den primära metoden för att hämta IPS-resurser. Den här metoden används för olika syften, till exempel för att bläddra i mapphierarkin eller för att hitta en specifik resurs efter namn.

Svarsstorlek

searchAssets returnerar upp till 1 000 resurser i ett enda anrop. Om du vill returnera upp till 10 000 resurser per anrop begränsar du svarsdata till en delmängd av fälten totalRows, name, handle, type och subType. Om du vill returnera större uppsättningar ställer du in sidindelning med parametern resultPage.

Begränsa resultatfilens storlek med responseFieldArray eller excludeFieldArray

Begränsa storleken på datauppsättningen med parametrarna responseFieldArray eller excludFieldArray. De här parametrarna minskar minnesanvändningen och bandbredden och kan förbättra svarstiderna på servern.

Auktoriserade användartyper section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Användaren måste ha läsåtkomst för att kunna returnera resurser.

Parametrar section-49aabc0600764f55a8b7017d86ded44f

Indata (searchAssetsParam)

Namn
Typ
Obligatoriskt?
Beskrivning
companyHandle
xsd:string
Ja
Handtaget till företaget med de resurser som du vill söka efter.
accessUserHandle
xsd:string
Nej
Gör att administratörer kan arbeta som en annan användare.
accessGroupHandle
xsd:string
Nej
Gör att administratörer kan arbeta som en del av en annan grupp.
mapp
xsd:string
Nej
Rotsökvägen för att söka efter resurser. Om det utelämnas används företagets rotmapp.
includeSubfolders
xsd:boolesk
Nej
Ange true om du vill söka efter undermappar.
publishState
xsd:string
Nej
Publish val.
trashState
xsd:string
Nej
Val av papperskorgsläge. Standardvärdet är NotInTrash .
conditionMatchMode
xsd:string
Nej

Val av sökmatchningslägen för kombination av resultat för keywordArray,

conditionMatchMode

systemFieldConditionArray och metadataConditionArray. Standard är MatchAll.

keywordArray
typer:StringArray
Nej

Obs! Inaktuell parameter. Det rekommenderas att du inte använder den.

En strängarray med nyckelord som ska matchas.

systemFieldMatchMode
xsd:string
Nej

Val av sökmatchningslägen för kombination av systemFieldCondition -träffar. Standard är MatchAll

.

systemFieldConditionArray
typer:SystemFieldConditionArray
Nej
Arrayen med systemfältvillkor.
tagMatchMode
xsd:string
Nej
Sök efter strängkonstanter för Matcha lägen. Standardvärdet är MatchAll.
tagConditionArray
typer:TagConditionArray
Nej

En array med sökpredikat för taggfält.

Predikaten kombineras enligt inställningen tagMatchMode och kombineras sedan med andra termer i keywordArray , systemFieldConditionArray och metadataConditionArray enligt inställningen conditionMatchMode .

metadataMatchMode
xsd:string
Nej
Sök i Matcha lägen för att kombinera metadataCondition-träffar. Standard är MatchAll.
metadataConditionArray
typer:MetadataConditionArray
Nej
Arrayen med sökvillkor för metadatafält.
assetTypeArray
typer:StringArray
Nej
Array med resurstyper som ska ingå i sökningen.
excludeAssetTypeArray
typer:StringArray
Nej
En array med resurstyper som ska uteslutas från sökningen.
assetSubTypeArray
typer:StringArray
Nej
En lista med undertypsnamn att filtrera mot.
strictSubTypeCheck
xsd:boolesk
Nej
Om true och assetSubTypeArray inte är tomma returneras bara resurser vars undertyper är i assetSubTypeArray . Om false (standard) returneras resurser utan definierad undertyp.
excludeByproducts
xsd:boolesk
Nej
Om värdet är true utesluts byproduktresurser som genereras vid förtäring av en primär resurs, t.ex. bilder på en rippad PDF-sida, från sökresultaten. Standardvärdet är false.
excludByproductArray
typer:ExcludeByproductArray
Nej
Matris med villkor för generering av produktresurser som ska uteslutas från sökresultatet. Om den här parametern finns åsidosätter den inställningen excludeByproducts.
projectHandle
xsd:sting
Nej
Hantering av ett projekt som innehåller de resurser som ska sökas igenom.
recordsPerPage
xsd:int
Nej
Maximalt antal resultat som ska returneras.
resultsPage
xsd:int
Nej
Anger den resultatsida som ska returneras baserat på sidstorleken recordsPerPage .
sortBy
xsd:string
Nej
Val av resurssorteringsfält.
sortDirection
xsd:string
Nej
Val av sorteringsriktning.
responseFieldArray
typer:StringArray
Nej
Innehåller en lista med fält och underfält som ska inkluderas i svaret.
excludeFieldArray
typer:StringArray
Nej
Innehåller en lista med fält och underfält som ska uteslutas från svaret.

Utdata (searchAssetsReturn)

Namn
Typ
Obligatoriskt
Beskrivning
totalRows
xsd:int
Nej
Antal rader som en sökning returnerar när poster per sida inte är begränsade.
assetArray
types:AssetArray
Nej
Assets som sökningen returnerar.

Exempel section-725484cc09b54772a838ad2cc930b94b

Det här kodexemplet söker efter bildresurser som tillhör ett visst företag. Svaret kortas av för att vara kortfattat.

Begäran

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

Svar

<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