searchAssets

Cerca le risorse in base ai criteri specificati.

Sintassi

searchAssets: Informazioni

searchAssets è il metodo principale per recuperare le risorse IPS. Questo metodo viene utilizzato per vari scopi, ad esempio per sfogliare la gerarchia delle cartelle o trovare una risorsa specifica per nome.

Dimensione risposta

searchAssets restituisce fino a 1000 risorse in una singola chiamata. Per restituire fino a 10.000 risorse per chiamata, limita i dati di risposta a un sottoinsieme della totalRows, name, handle, typee subType campi. Per restituire set più grandi, imposta il paging con resultPage parametro .

Limita le dimensioni del file dei risultati con responseFieldArray o excludeFieldArray

Limita le dimensioni del set di dati con responseFieldArray o excludFieldArray Parametri. Questi parametri contribuiscono a ridurre l'utilizzo della memoria e della larghezza di banda e possono migliorare i tempi di risposta del server.

Tipi di utenti autorizzati

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTA

L’utente deve disporre dell’accesso in lettura per restituire le risorse.

Parametri

Input (searchAssetsParam)

Nome Tipo Obbligatorio? Descrizione
companyHandle xsd:string L’handle dell’azienda con le risorse da cercare.
accessUserHandle xsd:string No Consente agli amministratori di lavorare come un altro utente.
accessGroupHandle xsd:string No Consente agli amministratori di lavorare come parte di un gruppo diverso.
cartella xsd:string No Percorso principale per la ricerca delle risorse. Se omesso, verrà utilizzata la cartella principale della società.
includeSubfolder xsd:boolean No Imposta su true per cercare le sottocartelle.
publishState xsd:string No Selezione dello stato di pubblicazione.
trashState xsd:string No Scelta dello stato del cestino. Il valore predefinito è NotInTrash.
conditionMatchMode xsd:string No

Scelta delle modalità di corrispondenza della ricerca per combinare i risultati di keywordArray,

conditionMatchMode

systemFieldConditionArraye metadataConditionArray. Il valore predefinito è MatchAll.

keywordArray tipi:StringArray No

Nota: Parametro obsoleto. Si consiglia di non utilizzarlo.

Matrice di stringhe di parole chiave da abbinare.

systemFieldMatchMode xsd:string No

Scelta delle modalità di corrispondenza di ricerca per combinare systemFieldCondition corrisponde. Il valore predefinito è MatchAll

.

systemFieldConditionArray

tipi:SystemFieldConditionArray

No Matrice di condizioni del campo di sistema.
tagMatchMode xsd:string No Costanti stringa in modalità di corrispondenza ricerca. Il valore predefinito è MatchAll.
tagConditionArray tipi:TagConditionArray No

Matrice di predicati per la ricerca di campi di tag.

I predicati vengono combinati in base al tagMatchMode e quindi combinati con qualsiasi termine in keywordArray, systemFieldConditionArraye metadataConditionArray in base al conditionMatchMode impostazione.

metadataMatchMode xsd:string No Modalità di ricerca per combinare metadataCondition corrisponde. Il valore predefinito è MatchAll.
metadataConditionArray

tipi:MetadataConditionArray

No Matrice di condizioni di ricerca dei campi di metadati.
assetTypeArray tipi:StringArray No Array di tipi di risorse da includere nella ricerca.
excludeAssetTypeArray tipi:StringArray No Array di tipi di risorse da escludere dalla ricerca.
assetSubTypeArray tipi:StringArray No Elenco di nomi di sottotipo su cui eseguire il filtro.
narrowSubTypeCheck xsd:boolean No Se true e assetSubTypeArray non è vuoto, solo le risorse i cui sottotipi sono in assetSubTypeArray vengono restituiti. Se false (Impostazione predefinita), vengono restituite risorse senza sottotipo definito.
excludeByproducts xsd:boolean No Se true, le risorse per sottoprodotto generate durante l’assimilazione di una risorsa principale, come le immagini di una pagina PDF strappate, sono escluse dai risultati della ricerca. Il valore predefinito è false.
excludByproductArray

tipi:ExcludeByproductArray

No Array di condizioni di generazione delle risorse per sottoprodotto da escludere dai risultati della ricerca. Se presente, questo parametro sostituisce l’impostazione excludeByproducts .
projectHandle xsd:stringa No Gestione di un progetto contenente le risorse da cercare.
recordsPerPage xsd:int No Numero massimo di risultati da restituire.
resultPage xsd:int No Specifica la pagina dei risultati da restituire, in base a recordsPerPage dimensioni della pagina.
sortBy xsd:string No Scelta dei campi di ordinamento delle risorse.
sortDirection xsd:string No Scelta del tipo di direzione.
responseFieldArray tipi:StringArray No Contiene un elenco di campi e sottocampi da includere nella risposta.
excludeFieldArray tipi:StringArray No Contiene un elenco di campi e sottocampi da escludere dalla risposta.

Output (searchAssetsReturn)

Nome Tipo Obbligatorio Descrizione
totalRows xsd:int No Numero di righe restituite da una ricerca quando i record per pagina non sono limitati.
assetArray types:AssetArray No Risorse restituite dalla ricerca.

Esempi

Questo esempio di codice cerca le risorse di immagini che appartengono a una società specifica. La risposta viene troncata per brevità.

Request Contents (Richiesta contenuto)

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

Risposta

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

In questa pagina