Documentazione API di Dynamic Medie Image Production System

searchAssets searchassets

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Argomenti:

Creato per:

Sviluppatore
Amministratore

Cerca le risorse in base ai criteri specificati.

Sintassi

searchAssets: informazioni section-4ad74f12eb754768bf85bd235a7e25f0

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 dei campi totalRows, name, handle, type e subType. Per restituire set più grandi, impostare il paging con il parametro resultPage.

Limita dimensione file risultati con responseFieldArray o excludeFieldArray

Limita le dimensioni del set di dati con i parametri responseFieldArray o excludFieldArray. 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 section-9c4bc41bb8b4493982197eb13c7cdc55

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

NOTE

Per restituire le risorse, l’utente deve disporre dell’accesso in lettura.

Parametri section-49aabc0600764f55a8b7017d86ded44f

Input (searchAssetsParam)

Nome

Tipo

Obbligatorio

Descrizione

companyHandle

xsd:string

Sì

Handle dell’azienda in cui si desidera cercare le risorse.

accessUserHandle

xsd:string

Consente agli amministratori di lavorare come un altro utente.

accessGroupHandle

xsd:string

Consente agli amministratori di lavorare come parte di un gruppo diverso.

cartella

xsd:string

Percorso directory principale per la ricerca delle risorse. Se omesso, viene utilizzata la cartella principale dell’azienda.

includeSubfolders

xsd:booleano

Impostare su true per cercare le sottocartelle.

publishState

xsd:string

Scelta dello stato di Publish.

trashState

xsd:string

Scelta stato cestino. Il valore predefinito è NotInTrash.

conditionMatchMode

xsd:string

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

ConditionMatchMode

systemFieldConditionArray e metadataConditionArray. Il valore predefinito è MatchAll.

keywordArray

tipi:StringArray

Nota: parametro obsoleto. Si consiglia di non usarlo.

Matrice di stringhe di parole chiave da trovare.

systemFieldMatchMode

xsd:string

Scelta delle modalità di ricerca per la combinazione di corrispondenze systemFieldCondition. Il valore predefinito è MatchAll

systemFieldConditionArray

tipi:SystemFieldConditionArray

Array delle condizioni dei campi di sistema.

tagMatchMode

xsd:string

Ricerca in modalità di corrispondenza: costanti stringa. Il valore predefinito è MatchAll.

tagConditionArray

tipi:TagConditionArray

Array dei predicati di ricerca dei campi tag.

I predicati vengono combinati in base all'impostazione tagMatchMode e quindi combinati con qualsiasi termine in keywordArray, systemFieldConditionArray e metadataConditionArray in base all'impostazione conditionMatchMode.

metadataMatchMode

xsd:string

Cerca modalità di corrispondenza per combinare corrispondenze metadataCondition. Il valore predefinito è MatchAll.

metadataConditionArray

tipi:MetadataConditionArray

Array delle condizioni di ricerca dei campi di metadati.

assetTypeArray

tipi:StringArray

Array di tipi di risorse da includere nella ricerca.

excludeAssetTypeArray

tipi:StringArray

Array di tipi di risorse da escludere dalla ricerca.

assetSubTypeArray

tipi:StringArray

Elenco di nomi di sottotipi su cui filtrare.

strictSubTypeCheck

xsd:booleano

Se true e assetSubTypeArray non è vuoto, vengono restituite solo le risorse i cui sottotipi si trovano in assetSubTypeArray. Se false (impostazione predefinita), vengono restituite le risorse senza sottotipo definito.

excludeByproducts

xsd:booleano

Se true, le risorse dei sottoprodotti generate durante l’acquisizione di una risorsa principale, ad esempio le immagini di pagina di PDF strappate, vengono escluse dai risultati della ricerca. Il valore predefinito è false.

excludByproductArray

tipi:ExcludeByproductArray

Array di condizioni di generazione risorse sottoprodotto da escludere dai risultati di ricerca. Se presente, questo parametro sostituisce l’impostazione excludeByproducts.

projectHandle

xsd:sting

Handle di un progetto contenente le risorse da cercare.

recordPerPage

xsd:int

Numero massimo di risultati da restituire.

risultatiPagina

xsd:int

Specifica la pagina dei risultati da restituire, in base alle dimensioni di pagina recordsPerPage.

sortBy

xsd:string

Scelta dei campi di ordinamento delle risorse.

sortDirection

xsd:string

Scelta della direzione di ordinamento.

responseFieldArray

tipi:StringArray

Contiene un elenco di campi e sottocampi da includere nella risposta.

excludeFieldArray

tipi:StringArray

Contiene un elenco di campi e sottocampi da escludere dalla risposta.

Output (searchAssetsReturn)

Nome

Tipo

Obbligatorio

Descrizione

totalRows

xsd:int

Numero di righe restituite da una ricerca quando i record per pagina non sono limitati.

assetArray

types:AssetArray

Assets restituito dalla ricerca.

Esempi section-725484cc09b54772a838ad2cc930b94b

In questo esempio di codice vengono cercate le risorse immagine che appartengono a una società specifica. La risposta viene troncata per brevità.

Richiesta

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

recommendation-more-help

4e9b9d8c-5839-4215-aa35-01b652869681