Skip to content

Latest commit

 

History

History
84 lines (70 loc) · 2.92 KB

SearchSpreadsheetAllTextItems.md

File metadata and controls

84 lines (70 loc) · 2.92 KB

Spreadsheet Cloud API: searchSpreadsheetAllTextItems

Get all text items in the remote spreadsheet.

Quick Start

  • Base URL: http://api.aspose.cloud/v4.0
  • Authentication Method: JWT (OAuth2, application) Token URL: https://api.aspose.cloud/connect/token
  • Example

Interface Details

Endpoint

PUT http://api.aspose.cloud/v4.0/cells/search/content/all-textitems

Function Description

This method searches for all text item within a local spreadsheet file. It supports searching through all sheets and cells of the workbook, identifying occurrences of the search term. The operation is performed cloudly, requiring no cloud storage. Ensure that you have the necessary permissions to read the source file. If the source file cannot be accessed or if an error occurs during the search process (such as an unsupported file format), an appropriate exception will be thrown. The method may return the locations of the matches (e.g., sheet name, cell coordinates) depending on implementation details. ## Error Handling- 400 Bad Request: Invalid url.- 401 Unauthorized: Authentication has failed, or no credentials were provided.- 404 Not Found: Source file not accessible.- 500 Server Error The spreadsheet has encountered an anomaly in obtaining data.

The request parameters of searchSpreadsheetAllTextItems API are:

Parameter Name Type Path/Query String/HTTPBody Description
Spreadsheet File FormData Upload spreadsheet file.
region String Query The spreadsheet region setting.
password String Query The password for opening spreadsheet file.

Response Description

{
  "Name": "SearchResponse",
  "Type": "Class",
  "ParentName": "CellsCloudResponse",
  "IsAbstract": false,
  "Properties": [
    {
      "Name": "TextItems",
      "Nullable": true,
      "ReadOnly": false,
      "IsInherit": false,
      "DataType": {
        "Identifier": "Container",
        "Reference": "TextItem",
        "ElementDataType": {
          "Identifier": "Class",
          "Reference": "TextItem",
          "Name": "class:textitem"
        },
        "Name": "container"
      }
    },
    {
      "Name": "Code",
      "Nullable": true,
      "ReadOnly": false,
      "IsInherit": true,
      "DataType": {
        "Identifier": "Integer",
        "Name": "integer"
      }
    },
    {
      "Name": "Status",
      "Nullable": true,
      "ReadOnly": false,
      "IsInherit": true,
      "DataType": {
        "Identifier": "String",
        "Name": "string"
      }
    }
  ]
}

OpenAPI Specification

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

[Back to API list]
[Back to README]