getAssetsByName

Renvoie les ressources en fonction d’un tableau de noms de ressources.

Syntaxe

Types d’utilisateurs autorisés

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
REMARQUE

Renvoie uniquement les ressources auxquelles l’utilisateur a accès en lecture.

Paramètres

Entrée (getAssetsByNameParam)

Nom Type Obligatoire Description
companyHandle xsd:string Oui La poignée de la société.
accessUserHandle xsd:string Non Fournit l’accès en tant qu’autre utilisateur. Disponible uniquement pour les administrateurs.
accessGroupHandle xsd:string Non Utilisé pour filtrer selon un groupe spécifique.
nameArray types:StringArray Oui Tableau des noms de ressources à récupérer.
assetTypeArray types:StringArray Non Tableau des types de ressources autorisés pour les ressources récupérées.
excludeAssetTypeArray types:StringArray Non Tableau des types de ressources exclus pour les ressources récupérées.
assetSubTypeArray types:StringArray Non Tableau des sous-types de ressources autorisés pour les ressources récupérées.
strictSubTypeCheck xsd:boolean Non

If true et assetSubTypeArray n’est pas vide, seules les ressources dont les sous-types se trouvent dans assetSubTypeArray sont renvoyées.

If false, les ressources sans sous-type défini sont incluses.

La valeur par défaut est false.

responseFieldArray types:StringArray Non Contient une liste des champs et sous-champs inclus dans la réponse.
excludeFieldArray types:StringArray Non Contient une liste des champs et des sous-champs exclus de la réponse.

Sortie (getAssetsByNameReturn)

Nom Type Obligatoire Description
assetArray types:AssetArray Non Tableau des ressources qui correspondent aux critères de filtrage.

Exemples

Cet exemple de code renvoie deux ressources de type image.

Request

<getAssetsByNameParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <companyHandle>c|3</companyHandle>
   <nameArray>
      <items>B010</items>
      <items>IMG_0103</items>
   </nameArray>
   <assetTypeArray>
      <items>Image</items>
   </assetTypeArray>
</getAssetsByNameParam>

Réponse

<getAssetsByNameReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <assetArray>
      <items>
         <assetHandle>a|210</assetHandle>
         <type>Image</type>
         <name>B010</name>
         ...</items>
      <items>
         <assetHandle>a|189</assetHandle>
         <type>Image</type>
         <name>IMG_0103</name>
         ...
      </items>
   </assetArray>
</getAssetsByNameReturn>

Sur cette page