DocumentationAPI du système d’exploitation d’images Dynamic Media

searchAssets searchassets

Last update: Fri Aug 15 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Rubriques :

Créé pour :

  • Développeur
  • Administration

Rechercher des ressources en fonction de vos critères spécifiés.

Syntaxe

searchAssets : à propos de section-4ad74f12eb754768bf85bd235a7e25f0

searchAssets est la principale méthode de récupération des ressources IPS. Cette méthode est utilisée à diverses fins, telles que la navigation dans la hiérarchie des dossiers ou la recherche d’une ressource spécifique par nom.

Taille de la réponse

searchAssets renvoie jusqu’à 1 000 ressources en un seul appel. Pour renvoyer jusqu’à 10 000 ressources par appel, limitez les données de réponse à un sous-ensemble des champs totalRows, name, handle, type et subType. Pour renvoyer des visionneuses plus volumineuses, configurez la pagination avec le paramètre resultPage .

Limiter la taille du fichier de résultats avec responseFieldArray ou excludeFieldArray

Limitez la taille de votre jeu de données avec les paramètres responseFieldArray ou excludFieldArray. Ces paramètres permettent de réduire l’utilisation de la mémoire et de la bande passante et peuvent améliorer les temps de réponse du serveur.

Types d’utilisateurs autorisés section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
L’utilisateur doit disposer d’un accès en lecture pour renvoyer des ressources.

Paramètres section-49aabc0600764f55a8b7017d86ded44f

Input (searchAssetsParam)

Nom
Type
Obligatoire ?
Description
companyHandle
xsd:string
Oui
Le descripteur de la société avec les ressources que vous souhaitez rechercher.
accessUserHandle
xsd:string
Non
Permet aux administrateurs de travailler en tant qu’utilisateur différent.
accessGroupHandle
xsd:string
Non
Permet aux administrateurs de travailler dans le cadre d’un autre groupe.
dossier
xsd:string
Non
Chemin d’accès racine pour la recherche de ressources. Si cet attribut est omis, le dossier racine d’entreprise est utilisé.
includeSubfolders
xsd:boolean
Non
Définissez sur true pour rechercher des sous-dossiers.
publishState
xsd:string
Non
Choix de l’état de publication.
trashState
xsd:string
Non
Choix de l’état de la corbeille. La valeur par défaut est NotInTrash.
conditionMatchMode
xsd:string
Non

Choix des modes de correspondance de recherche pour combiner les résultats de keywordArray,

conditionMatchMode

systemFieldConditionArray et metadataConditionArray. La valeur par défaut est MatchAll.

keywordArray
types:StringArray
Non

Remarque : paramètre obsolète. Il est conseillé de ne pas l’utiliser.

Tableau de chaînes de mots-clés à faire correspondre.

systemFieldMatchMode
xsd:string
Non

Choix des modes de correspondance de recherche pour combiner correspondances systemFieldCondition. La valeur par défaut est MatchAll

.

systemFieldConditionArray
types:SystemFieldConditionArray
Non
Tableau de conditions de champ système.
tagMatchMode
xsd:string
Non
Constantes de chaîne des modes de correspondance de recherche. La valeur par défaut est MatchAll.
tagConditionArray
types : TagConditionArray
Non

Tableau de prédicats de recherche de champ de balise.

Les prédicats sont combinés selon le paramètre tagMatchMode, puis combinés avec tout terme keywordArray, systemFieldConditionArray et metadataConditionArray selon le paramètre conditionMatchMode.

metadataMatchMode
xsd:string
Non
Modes de correspondance de recherche pour combiner correspondances metadataCondition. La valeur par défaut est MatchAll.
metadataConditionArray
de données :MetadataConditionArray
Non
Tableau de conditions de recherche de champ de métadonnées.
assetTypeArray
types:StringArray
Non
Tableau des types de ressources à inclure dans la recherche.
excludeAssetTypeArray
types:StringArray
Non
Tableau des types de ressources à exclure de la recherche.
assetSubTypeArray
types:StringArray
Non
Liste de noms de sous-types en fonction desquels effectuer le filtrage.
strictSubTypeCheck
xsd:boolean
Non
Si valeur est true et assetSubTypeArray n’est pas vide, seules les ressources dont les sous-types se trouvent dans assetSubTypeArray sont renvoyées. Si la est false (par défaut), les ressources sans sous-type défini sont renvoyées.
excludeByproducts
xsd:boolean
Non
Si la valeur est true, les ressources de sous-produit générées lors de l’ingestion d’une ressource principale, telles que les images de page PDF extraites, sont exclues des résultats de la recherche. Faux par défaut.
excludByproductArray
types:ExcludeByproductArray
Non
Tableau de conditions de génération de ressources de sous-produit à exclure des résultats de recherche. S’il est présent, ce paramètre remplace le paramètre excludeByproducts.
projectHandle
xsd:string
Non
Gestionnaire d’un projet contenant les ressources à rechercher.
recordsPerPage
xsd:int
Non
Nombre maximum de résultats à retourner.
resultsPage
xsd:int
Non
Indique la page de résultats à renvoyer, en fonction de taille de page recordsPerPage.
sortBy
xsd:string
Non
Choix des champs de tri des ressources.
sortDirection
xsd:string
Non
Choix de la direction du tri.
responseFieldArray
types:StringArray
Non
Contient une liste de champs et de sous-champs à inclure dans la réponse.
excludeFieldArray
types:StringArray
Non
Contient une liste de champs et de sous-champs à exclure de la réponse.

Output (searchAssetsReturn)

Nom
Type
Obligatoire
Description
totalRows
xsd:int
Non
Nombre de lignes renvoyé par une recherche lorsque les enregistrements par page ne sont pas limités.
assetArray
types:AssetArray
Non
Assets renvoyée par la recherche.

Exemples section-725484cc09b54772a838ad2cc930b94b

Cet exemple de code recherche des ressources d’image appartenant à une société spécifique. La réponse est tronquée à des fins de concision.

Requête

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

Réponse

<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