DocumentationAPI du système de production d’images Dynamic Media

searchAssets searchassets

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

Créé pour :

  • Développeur
  • Administration

Recherchez des ressources en fonction des critères que vous avez spécifiés.

Syntaxe

searchAssets : à propos section-4ad74f12eb754768bf85bd235a7e25f0

searchAssets est la principale méthode de récupération des ressources IPS. Cette méthode est utilisée à diverses fins, par exemple pour parcourir la hiérarchie de dossiers ou rechercher une ressource spécifique par nom.

Taille de 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 jeux plus volumineux, configurez la pagination avec le paramètre resultPage .

Limit Result File Size with responseFieldArray or excludeFieldArray

Limitez la taille de votre jeu de données avec les paramètres responseFieldArray ou excludFieldArray . Ces paramètres réduisent 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 les ressources.

Paramètres section-49aabc0600764f55a8b7017d86ded44f

Entrée (searchAssetsParam)

Nom
Type
Obligatoire ?
Description
companyHandle
xsd:string
Oui
Gestion de l’entreprise 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.
folder
xsd:string
Non
Chemin d’accès racine pour la recherche de ressources. S’il est omis, le dossier racine de l’entreprise est utilisé.
includeSubfolders
xsd:boolean
Non
Définissez cette variable sur true pour rechercher des sous-dossiers.
publishState
xsd:string
Non
Choix de l’état Publish.
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 recherche pour la combinaison des 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 recherche pour la combinaison de systemFieldCondition correspondances. La valeur par défaut est MatchAll

.

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

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

Les prédicats sont combinés en fonction du paramètre tagMatchMode, puis combinés avec tous les termes de keywordArray, systemFieldConditionArray et metadataConditionArray en fonction du paramètre conditionMatchMode .

metadataMatchMode
xsd:string
Non
Modes de correspondance de recherche pour la combinaison de metadataCondition correspondances. La valeur par défaut est MatchAll.
metadataConditionArray
types : MetadataConditionArray
Non
Tableau de conditions de recherche de champs 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 à filtrer.
strictSubTypeCheck
xsd:boolean
Non
Si true et assetSubTypeArray n’est pas vide, seules les ressources dont les sous-types se trouvent dans assetSubTypeArray sont renvoyées. Si false (par défaut), les ressources sans sous-type défini sont renvoyées.
excludeByproducts
xsd:boolean
Non
Si la valeur est true, les sous-produits générés lors de l’ingestion d’une ressource principale, tels que les images de page de PDF arrachées, sont exclus des résultats de recherche. Faux par défaut.
excludByproductArray
types : ExcludeByproductArray
Non
Tableau des conditions de génération de ressources de sous-produits à exclure des résultats de recherche. S’il est présent, ce paramètre remplace le paramètre excludeByproducts .
projectHandle
xsd:string
Non
Gérer un projet contenant les ressources à rechercher.
recordsPerPage
xsd:int
Non
Nombre maximal de résultats à renvoyer.
resultsPage
xsd:int
Non
Spécifie la page de résultats à renvoyer, en fonction de la 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.

Sortie (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 que la recherche renvoie.

Exemples section-725484cc09b54772a838ad2cc930b94b

Cet exemple de code recherche des ressources d’image qui appartiennent à une société spécifique. La réponse est tronquée pour la 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