DocumentazioneAPI di Dynamic Media Image Production System

searchAssets searchassets

Last update: Mon May 22 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Developer
  • Admin

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

Limita dimensione file 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 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:stringa
Sì
Handle dell’azienda in cui si desidera cercare le risorse.
accessUserHandle
xsd:stringa
No
Consente agli amministratori di lavorare come un altro utente.
accessGroupHandle
xsd:stringa
No
Consente agli amministratori di lavorare come parte di un gruppo diverso.
cartella
xsd:stringa
No
Percorso directory principale per la ricerca delle risorse. Se omesso, viene utilizzata la cartella principale dell’azienda.
includeSubfolders
xsd:booleano
No
Imposta su true per cercare sottocartelle.
publishState
xsd:stringa
No
Scelta stato pubblicazione.
trashState
xsd:stringa
No
Scelta stato cestino. Il valore predefinito è NotInTrash.
conditionMatchMode
xsd:stringa
No

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

conditionMatchMode

systemFieldConditionArray, e metadataConditionArray. Il valore predefinito è MatchAll.

keywordArray
tipi:StringArray
No

Nota: parametro obsoleto. Si consiglia di non usarlo.

Matrice di stringhe di parole chiave da trovare.

systemFieldMatchMode
xsd:stringa
No

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

.

systemFieldConditionArray
tipi:SystemFieldConditionArray
No
Array delle condizioni dei campi di sistema.
tagMatchMode
xsd:stringa
No
Ricerca in modalità di corrispondenza: costanti stringa. Il valore predefinito è MatchAll.
tagConditionArray
tipi:TagConditionArray
No

Array dei predicati di ricerca dei campi tag.

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

metadataMatchMode
xsd:stringa
No
Cerca modalità di corrispondenza per la combinazione metadataCondition corrisponde a. Il valore predefinito è MatchAll.
metadataConditionArray
tipi:MetadataConditionArray
No
Array delle 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 sottotipi su cui filtrare.
strictSubTypeCheck
xsd:booleano
No
Se true e assetSubTypeArray non è vuoto, solo le risorse i cui sottotipi sono in assetSubTypeArray vengono restituiti. Se false (impostazione predefinita), vengono restituite le risorse senza sottotipo definito.
excludeByproducts
xsd:booleano
No
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
No
Array di condizioni di generazione risorse sottoprodotto da escludere dai risultati di ricerca. Se presente, questo parametro sostituisce l’impostazione excludeByproducts.
projectHandle
xsd:sting
No
Handle di un progetto contenente le risorse da cercare.
recordsPerPage
xsd:int
No
Numero massimo di risultati da restituire.
resultsPage
xsd:int
No
Specifica la pagina di risultati da restituire, in base a recordsPerPage dimensioni della pagina.
sortBy
xsd:stringa
No
Scelta dei campi di ordinamento delle risorse.
sortDirection
xsd:stringa
No
Scelta della direzione di ordinamento.
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 section-725484cc09b54772a838ad2cc930b94b

In questo esempio di codice vengono cercate le risorse immagine 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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681