Obtener todas las formas en una hoja de cálculo de Excel

Esta API REST permite recuperar todas las formas en una hoja de cálculo de Excel.

Seguridad y autenticación

Las API de Aspose.Cells Cloud son seguras y requieren autenticación basada en token JWT.

API REST

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

Parámetros de solicitud

Nombre del parámetro	Tipo	Ubicación	Descripción
name	string	path	El nombre del archivo de Excel.
sheetName	string	path	El nombre de la hoja de cálculo.
folder	string	query	La carpeta que contiene el documento.
storageName	string	query	El nombre del servicio de almacenamiento a utilizar.
include	string	query	Establecer en `details` para devolver las propiedades completas de la forma; de lo contrario, solo se devuelven los objetos `link`.

Opcional: folder, storageName y include pueden omitirse si el archivo reside en el almacenamiento raíz.

Puede utilizar la herramienta de línea de comandos cURL para acceder a los servicios web de Aspose.Cells. El siguiente ejemplo muestra una solicitud que incluye los parámetros de consulta opcionales.

Solicitud

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 <jwt token>"

Respuesta

{
  "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"
}

Campos de respuesta

El objeto Shapes contiene una lista de elementos Shape. Cada forma incluye las siguientes propiedades (cuando se utiliza la bandera include=details; de lo contrario solo se devuelve el objeto link).

Propiedad	Tipo	Descripción
Name	string	El nombre asignado a la forma (por ejemplo, “Gráfico 1”).
Type	string	El tipo de forma (por ejemplo, `Chart`, `Picture`, `TextBox`).
Top	number	La distancia, en puntos, desde el borde superior de la hoja de cálculo hasta la forma.
Left	number	La distancia, en puntos, desde el borde izquierdo de la hoja de cálculo hasta la forma.
Width	number	El ancho de la forma en puntos.
Height	number	El alto de la forma en puntos.
Link	object	Información del hipervínculo (`Href`, `Rel`, `Type`, `Title`).

Manejo de errores

Estado HTTP	Descripción	Cuerpo de error de ejemplo
400	Solicitud incorrecta – parámetros mal formados.	`{ "Code": 400, "Message": "Invalid parameter value." }`
401	No autorizado – token ausente o no válido.	`{ "Code": 401, "Message": "Access token is missing or invalid." }`
404	No encontrado – el libro de trabajo o la hoja de cálculo no existen.	`{ "Code": 404, "Message": "File or worksheet not found." }`
500	Error interno del servidor – condición inesperada.	`{ "Code": 500, "Message": "An unexpected error occurred." }`

Una solicitud correcta devuelve HTTP 200 con un objeto Shapes que contiene la lista de formas, tal como se ilustra en el ejemplo de respuesta anterior.

La API impone un límite de 150 solicitudes por minuto por token JWT. Superar este límite devuelve HTTP 429 con un encabezado Retry-After que indica cuándo volver a intentar.

Familia de SDK en la nube

Utilizar un SDK es la mejor forma de acelerar el desarrollo. Un SDK gestiona los detalles de bajo nivel y le permite centrarse en las tareas de su proyecto. Consulte el repositorio de GitHub para ver una lista completa de los SDK de Aspose.Cells Cloud.

Los siguientes ejemplos de código muestran cómo realizar llamadas a los servicios web de Aspose.Cells mediante diversos SDK:

Obtener una forma por índice en una hoja de cálculo de Excel