Récupérer toutes les formes d'une feuille Excel

Cette API REST permet de récupérer toutes les formes présentes sur une feuille Excel.

Sécurité et authentification

Les API Aspose.Cells Cloud sont sécurisées et nécessitent une authentification basée sur un jeton JWT.

API REST

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/shapes

Paramètres de la requête

Nom du paramètre	Type	Emplacement	Description
name	string	path	Le nom du fichier Excel.
sheetName	string	path	Le nom de la feuille de calcul.
folder	string	query	Le dossier contenant le document.
storageName	string	query	Le nom du service de stockage à utiliser.
include	string	query	Définir sur `details` pour retourner les propriétés complètes des formes ; sinon, seuls les objets `link` sont retournés.

Optionnel : folder, storageName et include peuvent être omis si le fichier se trouve à la racine du stockage.

Vous pouvez utiliser l’outil en ligne de commande cURL pour accéder aux services web Aspose.Cells. L’exemple ci-dessous illustre une requête incluant les paramètres optionnels.

Requête

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/shapes?folder=Samples&storageName=MyStorage" \
-X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jeton jwt>"

Réponse

{
  "Shapes": {
    "ShapeList": [
      {
        "link": {
          "Href": "/0",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      },
      {
        "link": {
          "Href": "/1",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      },
      {
        "link": {
          "Href": "/2",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      },
      {
        "link": {
          "Href": "/3",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      }
    ],
    "link": {
      "Href": "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/shapes",
      "Rel": "self",
      "Type": null,
      "Title": null
    }
  },
  "Code": 200,
  "Status": "OK"
}

Champs de la réponse

L’objet Shapes contient une liste d’éléments Shape. Chaque forme inclut les propriétés suivantes (lorsque le drapeau include=details est utilisé ; sinon, seul l’objet link est retourné).

Propriété	Type	Description
Name	string	Le nom attribué à la forme (par ex. « Chart 1 »).
Type	string	Le type de forme (par ex. `Chart`, `Picture`, `TextBox`).
Top	number	La distance, en points, entre le bord supérieur de la feuille et la forme.
Left	number	La distance, en points, entre le bord gauche de la feuille et la forme.
Width	number	La largeur de la forme en points.
Height	number	La hauteur de la forme en points.
Link	object	Informations d’hyperlien (`Href`, `Rel`, `Type`, `Title`).

Gestion des erreurs

Statut HTTP	Description	Corps d’erreur example
400	Requête incorrecte – paramètres mal formés.	`{ "Code": 400, "Message": "Valeur de paramètre non valide." }`
401	Non autorisé – jeton manquant ou invalide.	`{ "Code": 401, "Message": "Le jeton d'accès est manquant ou invalide." }`
404	Non trouvé – classeur ou feuille de calcul inexistante.	`{ "Code": 404, "Message": "Fichier ou feuille de calcul introuvable." }`
500	Erreur interne du serveur – condition inattendue.	`{ "Code": 500, "Message": "Une erreur inattendue s'est produite." }`

Une requête réussie renvoie le code HTTP 200 accompagné d’un objet Shapes contenant la liste des formes, comme illustré dans l’exemple de réponse ci-dessus.

L’API impose une limite de 150 requêtes par minute et par jeton JWT. Dépasser cette limite renvoie HTTP 429 avec une entête Retry-After indiquant la date à laquelle la requête peut être réessayée.

Famille de SDK Cloud

L’utilisation d’un SDK constitue la méthode optimale pour accélérer le développement. Un SDK gère les détails de bas niveau, vous permettant ainsi de vous concentrer sur les tâches de votre projet. Veuillez consulter le dépôt GitHub pour obtenir la liste complète des SDK Aspose.Cells Cloud.

Les exemples de code ci-dessous illustrent comment appeler les services web Aspose.Cells à l’aide de divers SDK :

Obtenir une forme par son index dans une feuille Excel