{ "x-generator": "NSwag v12.0.14.0 (NJsonSchema v9.13.18.0 (Newtonsoft.Json v13.0.0.0))", "swagger": "2.0", "info": { "title": "Aspose.Cells Cloud API Reference", "version": "26.4.0" }, "host": "api.aspose.cloud", "basePath": "/v3.0", "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/cells/analyze": { "post": { "tags": [ "Analyse" ], "summary": "Perform business analysis of data in Excel files.", "description": " Aspose.Cells Cloud provides robust support for Excel data analysis, making it capable of parsing tables and range data for chart and pivot table output. This process is known for its intricacy.", "operationId": "PostAnalyzeExcel", "parameters": [ { "name": "analyzeExcelRequest", "in": "body", "required": true, "description": "Excel files and analysis output requirements", "schema": { "$ref": "#/definitions/AnalyzeExcelRequest" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter": { "get": { "tags": [ "AutoFilter" ], "summary": "Retrieve the description of auto filters from a worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining the description of auto filters from a worksheet, a process known for its intricacy.", "operationId": "GetWorksheetAutoFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/AutoFilterResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/dateFilter": { "put": { "tags": [ "AutoFilter" ], "summary": "Apply a date filter in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for applying a date filter in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetDateFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified AutoFilter applies.", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "dateTimeGroupingType", "in": "query", "required": true, "description": "Specifies how to group dateTime values (Day, Hour, Minute, Month, Second, Year).", "x-nullable": true }, { "type": "integer", "name": "year", "in": "query", "description": "The year.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "month", "in": "query", "description": "The month.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "day", "in": "query", "description": "The day.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "hour", "in": "query", "description": "The hour.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "minute", "in": "query", "description": "The minute.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "second", "in": "query", "description": "The second.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "boolean", "name": "matchBlanks", "in": "query", "description": "Match all blank cell in the list.", "x-nullable": true }, { "type": "boolean", "name": "refresh", "in": "query", "description": "Refresh auto filters to hide or unhide the rows.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "AutoFilter" ], "summary": "Remove a date filter in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for removing a date filter in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetDateFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "dateTimeGroupingType", "in": "query", "required": true, "description": "Specifies how to group dateTime values.", "x-nullable": true }, { "type": "integer", "name": "year", "in": "query", "description": "The year.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "month", "in": "query", "description": "The month.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "day", "in": "query", "description": "The day.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "hour", "in": "query", "description": "The hour.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "minute", "in": "query", "description": "The minute.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "second", "in": "query", "description": "The second.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/filter": { "put": { "tags": [ "AutoFilter" ], "summary": "Add a filter for a column in the worksheet.\n ", "description": " Aspose.Cells Cloud provides robust support for adding a filter for a column in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified AutoFilter applies.", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "criteria", "in": "query", "required": true, "description": "The custom criteria.", "x-nullable": true }, { "type": "boolean", "name": "matchBlanks", "in": "query", "description": "Match all blank cell in the list.", "x-nullable": true }, { "type": "boolean", "name": "refresh", "in": "query", "description": "Refresh auto filters to hide or unhide the rows.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "AutoFilter" ], "summary": "Delete a filter for a column in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a filter for a column in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "criteria", "in": "query", "description": "The custom criteria.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/iconFilter": { "put": { "tags": [ "AutoFilter" ], "summary": "Add an icon filter in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding an icon filter in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetIconFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified AutoFilter applies.", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "iconSetType", "in": "query", "required": true, "description": "The icon set type.", "x-nullable": true }, { "type": "integer", "name": "iconId", "in": "query", "required": true, "description": "The icon id.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "matchBlanks", "in": "query", "description": "Match all blank cell in the list.", "x-nullable": true }, { "type": "boolean", "name": "refresh", "in": "query", "description": "Refresh auto filters to hide or unhide the rows.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/custom": { "put": { "tags": [ "AutoFilter" ], "summary": "Filter a list with custom criteria in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for filtering a list with custom criteria in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetCustomFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified AutoFilter applies.", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "operatorType1", "in": "query", "required": true, "description": "The filter operator type", "x-nullable": true }, { "type": "string", "name": "criteria1", "in": "query", "required": true, "description": "The custom criteria.", "x-nullable": true }, { "type": "boolean", "name": "isAnd", "in": "query", "description": "true/false", "x-nullable": true }, { "type": "string", "name": "operatorType2", "in": "query", "x-nullable": true }, { "type": "string", "name": "criteria2", "in": "query", "description": "The custom criteria.", "x-nullable": true }, { "type": "boolean", "name": "matchBlanks", "in": "query", "description": "Match all blank cell in the list.", "x-nullable": true }, { "type": "boolean", "name": "refresh", "in": "query", "description": "Refresh auto filters to hide or unhide the rows.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/dynamicFilter": { "put": { "tags": [ "AutoFilter" ], "summary": "Add a dynamic filter in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a dynamic filter in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetDynamicFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified AutoFilter applies.", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "dynamicFilterType", "in": "query", "required": true, "description": "Dynamic filter type.", "x-nullable": true }, { "type": "boolean", "name": "matchBlanks", "in": "query", "description": "Match all blank cell in the list.", "x-nullable": true }, { "type": "boolean", "name": "refresh", "in": "query", "description": "Refresh auto filters to hide or unhide the rows.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/filterTop10": { "put": { "tags": [ "AutoFilter" ], "summary": "Filter the top 10 items in the list in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for filtering the top 10 items in the list in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetFilterTop10", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified AutoFilter applies.", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "isTop", "in": "query", "required": true, "description": "Indicates whether filter from top or bottom", "x-nullable": false }, { "type": "boolean", "name": "isPercent", "in": "query", "required": true, "description": "Indicates whether the items is percent or count", "x-nullable": false }, { "type": "integer", "name": "itemCount", "in": "query", "required": true, "description": "The item count", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "matchBlanks", "in": "query", "description": "Match all blank cell in the list.", "x-nullable": true }, { "type": "boolean", "name": "refresh", "in": "query", "description": "Refresh auto filters to hide or unhide the rows.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/colorFilter": { "put": { "tags": [ "AutoFilter" ], "summary": "Add a color filter in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a color filter in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetColorFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified AutoFilter applies.", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "name": "colorFilter", "in": "body", "required": true, "description": "color filter request.", "schema": { "$ref": "#/definitions/ColorFilterRequest" }, "x-nullable": true }, { "type": "boolean", "name": "matchBlanks", "in": "query", "description": "Match all blank cell in the list.", "x-nullable": true }, { "type": "boolean", "name": "refresh", "in": "query", "description": "Refresh auto filters to hide or unhide the rows.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/matchBlanks": { "post": { "tags": [ "AutoFilter" ], "summary": "Match all blank cells in the list.", "description": " Aspose.Cells Cloud provides robust support for matching all blank cells in the list, a process known for its intricacy. ", "operationId": "PostWorksheetMatchBlanks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/matchNonBlanks": { "post": { "tags": [ "AutoFilter" ], "summary": "Match all not blank cells in the list.", "description": " Aspose.Cells Cloud provides robust support for matching all not blank cells in the list, a process known for its intricacy. ", "operationId": "PostWorksheetMatchNonBlanks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autoFilter/refresh": { "post": { "tags": [ "AutoFilter" ], "summary": "Refresh auto filters in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for refreshing auto filters in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetAutoFilterRefresh", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/batch/convert": { "post": { "tags": [ "Batch" ], "summary": "Batch converting files that meet specific matching conditions.", "description": " Aspose.Cells Cloud provides robust support for batch converting files that meet specific matching conditions, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on.", "operationId": "PostBatchConvert", "parameters": [ { "name": "batchConvertRequest", "in": "body", "required": true, "description": "BatchConvertRequest Batch conversion file request. ", "schema": { "$ref": "#/definitions/BatchConvertRequest" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } } }, "security": [ { "JWT": [] } ] } }, "/cells/batch/protect": { "post": { "tags": [ "Batch" ], "summary": "Batch protecting files that meet specific matching conditions.", "description": " Aspose.Cells Cloud provides robust support for batch protection files that meet specific matching conditions, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostBatchProtect", "parameters": [ { "name": "batchProtectRequest", "in": "body", "required": true, "description": "BatchProtectRequest Batch protection file request. ", "schema": { "$ref": "#/definitions/BatchProtectRequest" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } } }, "security": [ { "JWT": [] } ] } }, "/cells/batch/lock": { "post": { "tags": [ "Batch" ], "summary": "Batch locking files that meet specific matching conditions.", "description": " Aspose.Cells Cloud provides robust support for batch locking files that meet specific matching conditions, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostBatchLock", "parameters": [ { "name": "batchLockRequest", "in": "body", "required": true, "description": "BatchLockRequest Batch locking file request. ", "schema": { "$ref": "#/definitions/BatchLockRequest" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } } }, "security": [ { "JWT": [] } ] } }, "/cells/batch/unlock": { "post": { "tags": [ "Batch" ], "summary": "Batch unlocking files that meet specific matching conditions.", "description": " Aspose.Cells Cloud provides robust support for batch unlocking files that meet specific matching conditions, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostBatchUnlock", "parameters": [ { "name": "batchLockRequest", "in": "body", "required": true, "description": "BatchLockRequest Batch locking file request. ", "schema": { "$ref": "#/definitions/BatchLockRequest" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } } }, "security": [ { "JWT": [] } ] } }, "/cells/batch/split": { "post": { "tags": [ "Batch" ], "summary": "Batch splitting files that meet specific matching conditions.", "description": " Aspose.Cells Cloud provides robust support for batch splitting files that meet specific matching conditions, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostBatchSplit", "parameters": [ { "name": "batchSplitRequest", "in": "body", "required": true, "description": "BatchSplitRequest Batch splitting file request. ", "schema": { "$ref": "#/definitions/BatchSplitRequest" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } } }, "security": [ { "JWT": [] } ] } }, "/cells/connect/token": { "post": { "tags": [ "CellsAuthority" ], "summary": "Get Access Token Result", "operationId": "PostAccessToken", "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "type": "string" } } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/clearcontents": { "post": { "tags": [ "Cells" ], "summary": "Clear cell area contents in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for clearing cell area contents in the worksheet, a process known for its intricacy.", "operationId": "PostClearContents", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "description": "Represents the range to which the specified cells applies.", "x-nullable": true }, { "type": "integer", "name": "startRow", "in": "query", "description": "The start row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "startColumn", "in": "query", "description": "The start column index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endRow", "in": "query", "description": "The end row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endColumn", "in": "query", "description": "The end column index.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/clearformats": { "post": { "tags": [ "Cells" ], "summary": "Clear cell formats in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for clearing cell area formats in the worksheet, a process known for its intricacy. ", "operationId": "PostClearFormats", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "description": "Represents the range to which the specified cells applies.", "x-nullable": true }, { "type": "integer", "name": "startRow", "in": "query", "description": "The start row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "startColumn", "in": "query", "description": "The start column index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endRow", "in": "query", "description": "The end row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endColumn", "in": "query", "description": "The end column index.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/style": { "post": { "tags": [ "Cells" ], "summary": "Update cell range styles in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating cell range styles in the worksheet, a process known for its intricacy. ", "operationId": "PostUpdateWorksheetRangeStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "Represents the range to which the specified cells applies.", "x-nullable": true }, { "name": "style", "in": "body", "required": true, "description": "Style with update style settings.", "schema": { "$ref": "#/definitions/Style" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/merge": { "post": { "tags": [ "Cells" ], "summary": "Merge cells in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for merging cells in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetMerge", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startRow", "in": "query", "required": true, "description": "The start row index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "startColumn", "in": "query", "required": true, "description": "The start column index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "required": true, "description": "The total rows number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalColumns", "in": "query", "required": true, "description": "The total columns number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/unmerge": { "post": { "tags": [ "Cells" ], "summary": "Unmerge cells in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for unmerging cells in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetUnmerge", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startRow", "in": "query", "required": true, "description": "The start row index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "startColumn", "in": "query", "required": true, "description": "The start column index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "required": true, "description": "The total rows number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalColumns", "in": "query", "required": true, "description": "The total columns number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells": { "get": { "tags": [ "Cells" ], "summary": "Retrieve cell descriptions in a specified format.", "description": " Aspose.Cells Cloud provides robust support for unmerging cells in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetCells", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "offest", "in": "query", "description": "Begginig offset.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "count", "in": "query", "description": "Maximum amount of cells in the response.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Cells" ], "summary": "Set the value of the range in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting the value of the rang in the worksheet, a process known for its intricacy. ", "operationId": "PostSetCellRangeValue", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellarea", "in": "query", "required": true, "description": "Cell area (like \"A1:C2\")", "x-nullable": true }, { "type": "string", "name": "value", "in": "query", "required": true, "description": "Range value", "x-nullable": true }, { "type": "string", "name": "type", "in": "query", "required": true, "description": "Value data type (like \"int\")", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/{cellOrMethodName}": { "get": { "tags": [ "Cells" ], "summary": "Retrieve cell data using either cell reference or method name in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for getting cell data using either cell reference or method name in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetCell", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellOrMethodName", "in": "path", "required": true, "description": "The cell's or method name. (Method name like firstcell, endcell etc.)", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "20": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "type": "string" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/style": { "get": { "tags": [ "Cells" ], "summary": "Retrieve cell style descriptions in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for getting cell style descriptions in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetCellStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "Cell's name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/StyleResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Cells" ], "summary": "Set cell style using cell name in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting cell style using cell name in the worksheet, a process known for its intricacy. ", "operationId": "PostUpdateWorksheetCellStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "name": "style", "in": "body", "required": true, "description": "Style with update style settings.", "schema": { "$ref": "#/definitions/Style" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/{cellName}": { "post": { "tags": [ "Cells" ], "summary": "Set cell value using cell name in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting cell value using cell name in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellSetValue", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "type": "string", "name": "value", "in": "query", "description": "The cell value.", "x-nullable": true }, { "type": "string", "name": "type", "in": "query", "description": "The value type.", "x-nullable": true }, { "type": "string", "name": "formula", "in": "query", "description": "Formula for cell", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/{destCellName}/copy": { "post": { "tags": [ "Cells" ], "summary": "Copy data from a source cell to a destination cell in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for copying data from a source cell to a destination cell in the worksheet, a process known for its intricacy. ", "operationId": "PostCopyCellIntoCell", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "destCellName", "in": "path", "required": true, "description": "The destination cell name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The destination worksheet name.", "x-nullable": false }, { "type": "string", "name": "worksheet", "in": "query", "required": true, "description": "The source worksheet name.", "x-nullable": true }, { "type": "string", "name": "cellname", "in": "query", "description": "The source cell name.", "x-nullable": true }, { "type": "integer", "name": "row", "in": "query", "description": "The source row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "column", "in": "query", "description": "The source column index.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/htmlstring": { "get": { "tags": [ "Cells" ], "summary": "Retrieve the HTML string containing data and specific formats in this cell.", "description": " Aspose.Cells Cloud provides robust support for getting the HTML string containing data and specific formats in this cell, a process known for its intricacy. ", "operationId": "GetCellHtmlString", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "type": "string" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Cells" ], "summary": "Set the HTML string containing data and specific formats in this cell.", "description": " Aspose.Cells Cloud provides robust support for setting the HTML string containing data and specific formats in this cell, a process known for its intricacy. ", "operationId": "PostSetCellHtmlString", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/calculate": { "post": { "tags": [ "Cells" ], "summary": "Calculate cell formula in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for calculating cell formula in the worksheet, a process known for its intricacy. ", "operationId": "PostCellCalculate", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "name": "options", "in": "body", "required": true, "description": "Calculation Options", "schema": { "$ref": "#/definitions/CalculationOptions" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/characters": { "post": { "tags": [ "Cells" ], "summary": "Set cell characters in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting cell characters in the worksheet, a process known for its intricacy. ", "operationId": "PostCellCharacters", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "name": "options", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/FontSetting" } }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns": { "get": { "tags": [ "Cells" ], "summary": "Retrieve descriptions of worksheet columns.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of worksheet columns, a process known for its intricacy.", "operationId": "GetWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "offset", "in": "query", "description": "The workdook folder.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "count", "in": "query", "format": "int32", "default": 25, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ColumnsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}": { "post": { "tags": [ "Cells" ], "summary": "Set worksheet column width.", "description": " Aspose.Cells Cloud provides robust support for setting worksheet column width in the worksheet, a process known for its intricacy. ", "operationId": "PostSetWorksheetColumnWidth", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "columnIndex", "in": "path", "required": true, "description": "The column index.", "format": "int32", "x-nullable": false }, { "type": "number", "name": "width", "in": "query", "required": true, "description": "Gets and sets the column width in unit of characters.", "format": "double", "x-nullable": false }, { "type": "integer", "name": "count", "in": "query", "format": "int32", "default": 1, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "get": { "tags": [ "Cells" ], "summary": "Retrieve worksheet column data by column index.", "description": " Aspose.Cells Cloud provides robust support for obtaining worksheet column data by column index in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetColumn", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "columnIndex", "in": "path", "required": true, "description": "The column index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ColumnResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Cells" ], "summary": "Insert worksheet columns in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for inserting worksheet columns in the worksheet, a process known for its intricacy. ", "operationId": "PutInsertWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "columnIndex", "in": "path", "required": true, "description": "The column index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "columns", "in": "query", "required": true, "description": "The number of columns.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "updateReference", "in": "query", "description": "Indicates if references in other worksheets will be updated.", "default": true, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Cells" ], "summary": "Delete worksheet columns in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting worksheet columns in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "columnIndex", "in": "path", "required": true, "description": "The column index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "columns", "in": "query", "required": true, "description": "The number of columns.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "updateReference", "in": "query", "required": true, "description": "Indicates if references in other worksheets will be updated.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns/hide": { "post": { "tags": [ "Cells" ], "summary": "Hide worksheet columns in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for hiding worksheet columns in the worksheet, a process known for its intricacy. ", "operationId": "PostHideWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startColumn", "in": "query", "required": true, "description": "The begin column index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalColumns", "in": "query", "required": true, "description": "Number of columns to be operated.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns/unhide": { "post": { "tags": [ "Cells" ], "summary": "Unhide worksheet columns in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for unhiding worksheet columns in the worksheet, a process known for its intricacy. ", "operationId": "PostUnhideWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startColumn", "in": "query", "required": true, "description": "The begin column index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalColumns", "in": "query", "required": true, "description": "Number of columns to be operated.", "format": "int32", "x-nullable": false }, { "type": "number", "name": "width", "in": "query", "description": "Gets and sets the column width in unit of characters.", "format": "double", "default": 50.0, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns/group": { "post": { "tags": [ "Cells" ], "summary": "Group worksheet columns in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for grouping worksheet columns in the worksheet, a process known for its intricacy. ", "operationId": "PostGroupWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "firstIndex", "in": "query", "required": true, "description": "The first column index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "lastIndex", "in": "query", "required": true, "description": "The last column index to be operated.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "hide", "in": "query", "description": "columns visible state", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns/ungroup": { "post": { "tags": [ "Cells" ], "summary": "Ungroup worksheet columns.", "description": " Aspose.Cells Cloud provides robust support for ungrouping worksheet columns in the worksheet, a process known for its intricacy. ", "operationId": "PostUngroupWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "firstIndex", "in": "query", "required": true, "description": "The first column index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "lastIndex", "in": "query", "required": true, "description": "The last column index to be operated.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns/copy": { "post": { "tags": [ "Cells" ], "summary": "Copy data from source columns to destination columns in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for ungrouping worksheet columns in the worksheet, a process known for its intricacy. ", "operationId": "PostCopyWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "sourceColumnIndex", "in": "query", "required": true, "description": "Source column index", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "destinationColumnIndex", "in": "query", "required": true, "description": "Destination column index", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "columnNumber", "in": "query", "required": true, "description": "The copied column number", "format": "int32", "x-nullable": false }, { "type": "string", "name": "worksheet", "in": "query", "description": "The destination worksheet name.", "default": "", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}/style": { "post": { "tags": [ "Cells" ], "summary": "Set column style in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting column style in in the worksheet, a process known for its intricacy. ", "operationId": "PostColumnStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "columnIndex", "in": "path", "required": true, "description": "The column index.", "format": "int32", "x-nullable": false }, { "name": "style", "in": "body", "required": true, "description": "Represents display style of excel document,such as font,color,alignment,border,etc.", "schema": { "$ref": "#/definitions/Style" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows": { "get": { "tags": [ "Cells" ], "summary": "Retrieve descriptions of rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of rows in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "offset", "in": "query", "description": "Row offset. ", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "count", "in": "query", "description": "Display rows number.", "format": "int32", "default": 25, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/RowsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Cells" ], "summary": "Delete several rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting several rows in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startrow", "in": "query", "required": true, "description": "The begin row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "description": "Number of rows to be operated.", "format": "int32", "default": 1, "x-nullable": false }, { "type": "boolean", "name": "updateReference", "in": "query", "description": "Indicates if update references in other worksheets.", "default": true, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Cells" ], "summary": "Insert several new rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for inserting several new rows in the worksheet, a process known for its intricacy. ", "operationId": "PutInsertWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startrow", "in": "query", "required": true, "description": "The begin row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "description": "Number of rows to be operated.", "format": "int32", "default": 1, "x-nullable": false }, { "type": "boolean", "name": "updateReference", "in": "query", "description": "Indicates if update references in other worksheets.", "default": true, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows/{rowIndex}": { "get": { "tags": [ "Cells" ], "summary": "Retrieve row data by the row's index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining row data by the row's index in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetRow", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "rowIndex", "in": "path", "required": true, "description": "The row index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/RowResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Cells" ], "summary": "Delete a row in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a row in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetRow", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "rowIndex", "in": "path", "required": true, "description": "The row index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Cells" ], "summary": "Insert a new row in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for inserting a new row in the worksheet, a process known for its intricacy. ", "operationId": "PutInsertWorksheetRow", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "rowIndex", "in": "path", "required": true, "description": "The new row index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Cells" ], "summary": "Update height of rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating height of rows in the worksheet, a process known for its intricacy. ", "operationId": "PostUpdateWorksheetRow", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "rowIndex", "in": "path", "required": true, "description": "The row index.", "format": "int32", "x-nullable": false }, { "type": "number", "name": "height", "in": "query", "description": "The new row height.", "format": "double", "default": 0.0, "x-nullable": false }, { "type": "integer", "name": "count", "in": "query", "format": "int32", "default": 1, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows/hide": { "post": { "tags": [ "Cells" ], "summary": "Hide rows in worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating height of rows in the worksheet, a process known for its intricacy. ", "operationId": "PostHideWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startrow", "in": "query", "required": true, "description": "The begin row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "required": true, "description": "Number of rows to be operated.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows/unhide": { "post": { "tags": [ "Cells" ], "summary": "Unhide rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for unhiding rows in the worksheet, a process known for its intricacy. ", "operationId": "PostUnhideWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startrow", "in": "query", "required": true, "description": "The begin row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "required": true, "description": "Number of rows to be operated.", "format": "int32", "x-nullable": false }, { "type": "number", "name": "height", "in": "query", "description": "The new row height.", "format": "double", "default": 15.0, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows/group": { "post": { "tags": [ "Cells" ], "summary": "Group rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for grouping rows in the worksheet, a process known for its intricacy. ", "operationId": "PostGroupWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "firstIndex", "in": "query", "required": true, "description": "The first row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "lastIndex", "in": "query", "required": true, "description": "The last row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "hide", "in": "query", "description": "rows visible state", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows/ungroup": { "post": { "tags": [ "Cells" ], "summary": "Ungroup rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for ungrouping rows in the worksheet, a process known for its intricacy. ", "operationId": "PostUngroupWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "firstIndex", "in": "query", "required": true, "description": "The first row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "lastIndex", "in": "query", "required": true, "description": "The last row index to be operated.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "isAll", "in": "query", "description": "Is all row to be operated", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows/copy": { "post": { "tags": [ "Cells" ], "summary": "Copy data and formats from specific entire rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for copying data and formats from specific entire rows in the worksheet, a process known for its intricacy. ", "operationId": "PostCopyWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "sourceRowIndex", "in": "query", "required": true, "description": "Source row index", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "destinationRowIndex", "in": "query", "required": true, "description": "Destination row index", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "rowNumber", "in": "query", "required": true, "description": "The copied row number", "format": "int32", "x-nullable": false }, { "type": "string", "name": "worksheet", "in": "query", "description": "The worksheet name.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/cells/rows/{rowIndex}/style": { "post": { "tags": [ "Cells" ], "summary": "Apply formats to an entire row in the worksheet.\n ", "description": " Aspose.Cells Cloud provides robust support for applying formats to an entire row in the worksheet, a process known for its intricacy. ", "operationId": "PostRowStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "rowIndex", "in": "path", "required": true, "description": "The row index.", "format": "int32", "x-nullable": false }, { "name": "style", "in": "body", "required": true, "description": "Style description.", "schema": { "$ref": "#/definitions/Style" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells": { "get": { "tags": [ "CellsStatus" ], "summary": "Aspose.Cells Cloud service health status check.", "operationId": "GetCellsCloudServicesHealthCheck", "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "type": "string" } } }, "security": [ { "JWT": [] } ] } }, "/cells/status/check": { "get": { "tags": [ "CellsStatus" ], "summary": "Aspose.Cells Cloud service health status check. ", "operationId": "GetCellsCloudServiceStatus", "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "type": "string" } } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/chartArea": { "get": { "tags": [ "ChartArea" ], "summary": "Retrieve chart area description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining chart area description in the worksheet, a process known for its intricacy.", "operationId": "GetChartArea", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ChartAreaResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/chartArea/fillFormat": { "get": { "tags": [ "ChartArea" ], "summary": "Retrieve chart area fill format description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining chart fill format description in the worksheet, a process known for its intricacy. ", "operationId": "GetChartAreaFillFormat", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/FillFormatResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/chartArea/border": { "get": { "tags": [ "ChartArea" ], "summary": "Retrieve chart area border description.", "description": " Aspose.Cells Cloud provides robust support for obtaining chart area border description in the worksheet, a process known for its intricacy. ", "operationId": "GetChartAreaBorder", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/LineResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts": { "get": { "tags": [ "Charts" ], "summary": "Retrieve descriptions of charts in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of charts in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetCharts", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ChartsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Charts" ], "summary": "Add a new chart in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a new chart in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetChart", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "chartType", "in": "query", "required": true, "description": "Chart type, please refer property Type in chart resource.", "x-nullable": true }, { "type": "integer", "name": "upperLeftRow", "in": "query", "description": "Upper-left row for the new chart.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "upperLeftColumn", "in": "query", "description": "Upper-left column for the new chart.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "lowerRightRow", "in": "query", "description": "Lower-left row for the new chart.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "lowerRightColumn", "in": "query", "description": "Lower-left column for the new chart.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "string", "name": "area", "in": "query", "description": "Specify the values from which to plot the data series.", "x-nullable": true }, { "type": "boolean", "name": "isVertical", "in": "query", "description": "Specify whether to plot the series from a range of cell values by row or by column. ", "default": true, "x-nullable": false }, { "type": "string", "name": "categoryData", "in": "query", "description": "Get or set the range of category axis values. It can be a range of cells (e.g., \"D1:E10\").", "x-nullable": true }, { "type": "boolean", "name": "isAutoGetSerialName", "in": "query", "description": "Specify whether to auto-update the serial name.", "default": true, "x-nullable": false }, { "type": "string", "name": "title", "in": "query", "description": "Specify the chart title name.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "boolean", "name": "dataLabels", "in": "query", "description": "Represents the specified chart's data label values display behavior. True to display the values, False to hide them.", "default": true, "x-nullable": true }, { "type": "string", "name": "dataLabelsPosition", "in": "query", "description": "Represents data label position (Center/InsideBase/InsideEnd/OutsideEnd/Above/Below/Left/Right/BestFit/Moved).", "default": "Above", "x-nullable": true }, { "type": "string", "name": "pivotTableSheet", "in": "query", "description": "The source is the data of the pivotTable. If PivotSource is not empty, the chart is a PivotChart.", "x-nullable": true }, { "type": "string", "name": "pivotTableName", "in": "query", "description": "The pivot table name.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Charts" ], "summary": "Clear the charts in the worksheets.", "description": " Aspose.Cells Cloud provides robust support for clearing the charts in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetCharts", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartNumber}": { "get": { "tags": [ "Charts" ], "summary": "Retrieve the chart in a specified format.", "description": " Aspose.Cells Cloud provides robust support for obtaining the chart in a specified format, a process known for its intricacy. ", "operationId": "GetWorksheetChart", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartNumber", "in": "path", "required": true, "description": "The chart number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "description": "Chart conversion format.(PNG/TIFF/JPEG/GIF/EMF/BMP)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}": { "delete": { "tags": [ "Charts" ], "summary": "Delete a chart by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a chart by index in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetChart", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart properties in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating chart properties in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetChart", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "chart", "in": "body", "required": true, "description": "Chart Represents a specified chart.", "schema": { "$ref": "#/definitions/Chart" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/legend": { "get": { "tags": [ "Charts" ], "summary": "Retrieve chart legend description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining chart legend description in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetChartLegend", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/LegendResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart legend in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating chart legend description in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetChartLegend", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "legend", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Legend" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Charts" ], "summary": "Show chart legend in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for showing chart legend description in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetChartLegend", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Charts" ], "summary": "Hides chart legend in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for hiding chart legend description in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetChartLegend", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/title": { "get": { "tags": [ "Charts" ], "summary": "Retrieve chart title description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining chart title description in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetChartTitle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/TitleResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart title in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating chart title in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetChartTitle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "title", "in": "body", "required": true, "description": "TitleChart title", "schema": { "$ref": "#/definitions/Title" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Charts" ], "summary": "Set chart title in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting chart title in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetChartTitle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "title", "in": "body", "required": true, "description": "TitleChart title.", "schema": { "$ref": "#/definitions/Title" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Charts" ], "summary": "Hide chart title in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for hiding chart title in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetChartTitle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/seriesaxis": { "get": { "tags": [ "Charts" ], "summary": "Retrieve descriptions of chart seriesaxis in the chart.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of chart seriesaxis in the chart, a process known for its intricacy. ", "operationId": "GetChartSeriesAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/AxisResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart series axis in the chart.", "description": " Aspose.Cells Cloud provides robust support for updating chart series axis in the chart, a process known for its intricacy. ", "operationId": "PostChartSeriesAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "axis", "in": "body", "required": true, "description": "Axis ", "schema": { "$ref": "#/definitions/Axis" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/categoryaxis": { "get": { "tags": [ "Charts" ], "summary": "Retrieve descriptions of chart series axis in the chart.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of chart series axis in the chart, a process known for its intricacy. ", "operationId": "GetChartCategoryAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/AxisResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart category axis in the chart.", "description": " Aspose.Cells Cloud provides robust support for updating chart category axis in the chart, a process known for its intricacy. ", "operationId": "PostChartCategoryAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "axis", "in": "body", "required": true, "description": "Axis ", "schema": { "$ref": "#/definitions/Axis" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/valueaxis": { "get": { "tags": [ "Charts" ], "summary": "Retrieve chart value axis in the chart.", "description": " Aspose.Cells Cloud provides robust support for obtaining chart value axis in the chart, a process known for its intricacy. ", "operationId": "GetChartValueAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/AxisResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart value axis in the chart.", "description": " Aspose.Cells Cloud provides robust support for updating chart value axis in the chart, a process known for its intricacy. ", "operationId": "PostChartValueAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "axis", "in": "body", "required": true, "description": "Axis ", "schema": { "$ref": "#/definitions/Axis" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/secondcategoryaxis": { "get": { "tags": [ "Charts" ], "summary": "Retrieve chart second category axis in the chart", "description": " Aspose.Cells Cloud provides robust support for obtaining chart second category axis in the chart, a process known for its intricacy. ", "operationId": "GetChartSecondCategoryAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/AxisResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart sencond category axis in the chart.", "description": " Aspose.Cells Cloud provides robust support for updating chart sencond category axis in the chart, a process known for its intricacy. ", "operationId": "PostChartSecondCategoryAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "axis", "in": "body", "required": true, "description": "Axis ", "schema": { "$ref": "#/definitions/Axis" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/secondvalueaxis": { "get": { "tags": [ "Charts" ], "summary": "Retrieve chart second value axis in the chart.\n ", "description": " Aspose.Cells Cloud provides robust support for obtaining chart second value axis in the chart, a process known for its intricacy. ", "operationId": "GetChartSecondValueAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/AxisResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Charts" ], "summary": "Update chart sencond value axis in the chart.", "description": " Aspose.Cells Cloud provides robust support for updating chart sencond value axis in the chart, a process known for its intricacy. ", "operationId": "PostChartSecondValueAxis", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "chartIndex", "in": "path", "required": true, "description": "The chart index.", "format": "int32", "x-nullable": false }, { "name": "axis", "in": "body", "required": true, "description": "Axis ", "schema": { "$ref": "#/definitions/Axis" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/conditionalFormattings": { "get": { "tags": [ "ConditionalFormattings" ], "summary": "Retrieve descriptions of conditional formattings in a worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of conditional formattings in a worksheet, a process known for its intricacy.", "operationId": "GetWorksheetConditionalFormattings", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ConditionalFormattingsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "ConditionalFormattings" ], "summary": "Add conditional formatting in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding conditional formatting in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetConditionalFormatting", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "formatcondition", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FormatCondition" }, "x-nullable": true }, { "type": "string", "name": "cellArea", "in": "query", "required": true, "description": "Adds a conditional formatted cell range.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "ConditionalFormattings" ], "summary": "Clear all conditional formattings in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for clearing all conditional formattings in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetConditionalFormattings", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}": { "get": { "tags": [ "ConditionalFormattings" ], "summary": "Retrieve conditional formatting descriptions in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining conditional formatting descriptions in a worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetConditionalFormatting", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "The conditional formatting index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ConditionalFormattingResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "ConditionalFormattings" ], "summary": "Add a format condition in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a format condition in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetFormatCondition", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "Gets the Conditional Formatting element at the specified index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "cellArea", "in": "query", "required": true, "description": "Adds a conditional formatted cell range.", "x-nullable": true }, { "type": "string", "name": "type", "in": "query", "required": true, "description": "Format condition type(CellValue/Expression/ColorScale/DataBar/IconSet/Top10/UniqueValues/DuplicateValues/ContainsText/NotContainsText/BeginsWith/EndsWith/ContainsBlanks/NotContainsBlanks/ContainsErrors/NotContainsErrors/TimePeriod/AboveAverage).", "x-nullable": true }, { "type": "string", "name": "operatorType", "in": "query", "required": true, "description": "Represents the operator type of conditional format and data validation(Between/Equal/GreaterThan/GreaterOrEqual/LessThan/None/NotBetween/NotEqual).", "x-nullable": true }, { "type": "string", "name": "formula1", "in": "query", "required": true, "description": "The value or expression associated with conditional formatting.", "x-nullable": true }, { "type": "string", "name": "formula2", "in": "query", "required": true, "description": "The value or expression associated with conditional formatting.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "ConditionalFormattings" ], "summary": "Remove a conditional formatting.", "description": " Aspose.Cells Cloud provides robust support for removing a conditional formatting in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetConditionalFormatting", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "Gets the Conditional Formatting element at the specified index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}/area": { "put": { "tags": [ "ConditionalFormattings" ], "summary": "Add a cell area for the format condition in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a cell area for the format condition in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetFormatConditionArea", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "Gets the Conditional Formatting element at the specified index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "cellArea", "in": "query", "required": true, "description": "Adds a conditional formatted cell range.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}/condition": { "put": { "tags": [ "ConditionalFormattings" ], "summary": "Add a condition for the format condition in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a condition for the format condition in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetFormatConditionCondition", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "Gets the Conditional Formatting element at the specified index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "type", "in": "query", "required": true, "description": "Format condition type(CellValue/Expression/ColorScale/DataBar/IconSet/Top10/UniqueValues/DuplicateValues/ContainsText/NotContainsText/BeginsWith/EndsWith/ContainsBlanks/NotContainsBlanks/ContainsErrors/NotContainsErrors/TimePeriod/AboveAverage).", "x-nullable": true }, { "type": "string", "name": "operatorType", "in": "query", "required": true, "description": "Represents the operator type of conditional format and data validation(Between/Equal/GreaterThan/GreaterOrEqual/LessThan/None/NotBetween/NotEqual).", "x-nullable": true }, { "type": "string", "name": "formula1", "in": "query", "required": true, "description": "The value or expression associated with conditional formatting.", "x-nullable": true }, { "type": "string", "name": "formula2", "in": "query", "required": true, "description": "The value or expression associated with conditional formatting.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/area": { "delete": { "tags": [ "ConditionalFormattings" ], "summary": "Remove cell area from conditional formatting.", "description": " Aspose.Cells Cloud provides robust support for removing cell area from conditional formatting in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetConditionalFormattingArea", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startRow", "in": "query", "required": true, "description": "The start row of the range.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "startColumn", "in": "query", "required": true, "description": "The start column of the range.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "required": true, "description": "The number of rows of the range.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalColumns", "in": "query", "required": true, "description": "The number of columns of the range.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}": { "get": { "tags": [ "Conversion" ], "summary": "Retrieve workbooks in various formats.", "description": " Aspose.Cells Cloud provides robust support for Excel file format conversion, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on.", "operationId": "GetWorkbook", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "description": "The conversion format(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers).", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "isAutoFit", "in": "query", "description": "Specifies whether set workbook rows to be autofit.", "default": false, "x-nullable": false }, { "type": "boolean", "name": "onlySaveTable", "in": "query", "description": "Specifies whether only save table data.Only use pdf to excel.", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "description": "Path to save the result. If it's a single file, the `outPath` should encompass both the filename and extension. In the case of multiple files, the `outPath` should only include the folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outStorageName", "in": "query", "description": "The storage name where the output file is situated.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "boolean", "name": "pageWideFitOnPerSheet", "in": "query", "description": "The page wide fit on worksheet.", "x-nullable": true }, { "type": "boolean", "name": "pageTallFitOnPerSheet", "in": "query", "description": "The page tall fit on worksheet.", "x-nullable": true }, { "type": "boolean", "name": "onePagePerSheet", "in": "query", "description": "When converting to PDF format, one page per sheet.", "x-nullable": true }, { "type": "boolean", "name": "onlyAutofitTable", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Document info or conversion result if the conversion format is specified.\nor\nReturns 200 if the copy is successful.", "schema": {}, "x-expectedSchemas": [ { "description": "Document info or conversion result if the conversion format is specified.", "schema": { "$ref": "#/definitions/Stream" } }, { "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudFileInfoResponse" } } ] } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Workbook" ], "summary": "Create a new workbook using different methods.", "description": " Aspose.Cells Cloud provides robust support for creating a new workbook using different methods, a process known for its intricacy. ", "operationId": "PutWorkbookCreate", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The new document name.", "x-nullable": false }, { "type": "string", "name": "templateFile", "in": "query", "description": "The template file, if the data not provided default workbook is created.", "x-nullable": true }, { "type": "string", "name": "dataFile", "in": "query", "description": "Smart marker data file, if the data not provided the request content is checked for the data.", "x-nullable": true }, { "type": "boolean", "name": "isWriteOver", "in": "query", "description": "Specifies whether to write over targer file.", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "default": true, "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/convert": { "put": { "tags": [ "Conversion" ], "summary": "Convert the workbook from the requested content into files in different formats.", "description": " Aspose.Cells Cloud provides robust support for Excel file format conversion, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PutConvertWorkbook", "consumes": [ "multipart/form-data" ], "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "format", "in": "query", "required": true, "description": "The format to convert(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers).", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "description": "Path to save the result. If it's a single file, the `outPath` should encompass both the filename and extension. In the case of multiple files, the `outPath` should only include the folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "streamFormat", "in": "query", "description": "The format of the input file stream. ", "x-nullable": true }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "boolean", "name": "pageWideFitOnPerSheet", "in": "query", "description": "The page wide fit on worksheet.", "x-nullable": true }, { "type": "boolean", "name": "pageTallFitOnPerSheet", "in": "query", "description": "The page tall fit on worksheet.", "x-nullable": true }, { "type": "string", "name": "sheetName", "in": "query", "description": "Convert the specified worksheet. ", "x-nullable": true }, { "type": "integer", "name": "pageIndex", "in": "query", "description": "Convert the specified page of worksheet, sheetName is required. ", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "onePagePerSheet", "in": "query", "description": "When converting to PDF format, one page per sheet. ", "x-nullable": true }, { "type": "boolean", "name": "AutoRowsFit", "in": "query", "description": "Auto-fits all rows in this workbook.", "x-nullable": true }, { "type": "boolean", "name": "AutoColumnsFit", "in": "query", "description": "Auto-fits the columns width in this workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/SaveAs": { "post": { "tags": [ "Conversion" ], "summary": "Save an Excel file in various formats.", "description": " Aspose.Cells Cloud provides robust support for saving Excel files in various formats, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostWorkbookSaveAs", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "newfilename", "in": "query", "required": true, "description": "newfilename to save the result.The `newfilename` should encompass both the filename and extension.", "x-nullable": true }, { "name": "saveOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SaveOptions" }, "x-nullable": true }, { "type": "boolean", "name": "isAutoFitRows", "in": "query", "description": "Indicates if Autofit rows in workbook.", "default": false, "x-nullable": false }, { "type": "boolean", "name": "isAutoFitColumns", "in": "query", "description": "Indicates if Autofit columns in workbook.", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outStorageName", "in": "query", "description": "The storage name where the output file is situated.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": false, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "boolean", "name": "pageWideFitOnPerSheet", "in": "query", "description": "The page wide fit on worksheet.", "x-nullable": true }, { "type": "boolean", "name": "pageTallFitOnPerSheet", "in": "query", "description": "The page tall fit on worksheet.", "x-nullable": true }, { "type": "boolean", "name": "onePagePerSheet", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SaveResponse with the operation result.", "schema": { "$ref": "#/definitions/SaveResponse" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/pdf": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to PDF files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to PDF files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToPDF", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/png": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to PNG files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to PNG files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToPNG", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/docx": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to Docx files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to Docx files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToDocx", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/pptx": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to Pptx files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to Pptx files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToPptx", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/html": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to HTML files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to HTML files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToHtml", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/markdown": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to Markdown files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to Markdown files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToMarkdown", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/json": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to Json files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to Json files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToJson", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/sql": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to SQL Script files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to SQL Script files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToSQL", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convert/csv": { "post": { "tags": [ "Conversion" ], "summary": "Convert Excel file to Csv files.", "description": " Aspose.Cells Cloud provides robust support for converting Excel files to Csv files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on. ", "operationId": "PostConvertWorkbookToCSV", "parameters": [ { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "data file stream", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convertWorksheetToImage": { "post": { "tags": [ "Conversion" ], "operationId": "PostConvertWorksheetToImage", "parameters": [ { "name": "convertWorksheetOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConvertWorksheetOptions" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/convertWorkbook": { "post": { "tags": [ "Conversion" ], "operationId": "PostConvertWorkbook", "parameters": [ { "name": "convertWorkbookOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConvertWorkbookOptions" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/checkexternalreference": { "post": { "tags": [ "DataChecking" ], "summary": "Export Excel internal elements or the workbook itself to various format files.", "operationId": "CheckWrokbookExternalReference", "parameters": [ { "name": "checkExternalReferenceOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckExternalReferenceOptions" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "type": "string" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/checkformulaerrors": { "post": { "tags": [ "DataChecking" ], "operationId": "CheckWorkbookFormulaErrors", "parameters": [ { "name": "formulaErrorOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckFormulaErrorOptions" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "type": "string" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/export": { "post": { "tags": [ "DataProcessing" ], "summary": "Export Excel internal elements or the workbook itself to various format files.", "description": " Aspose.Cells Cloud provides robust support for exporting Excel internal elements or the workbook itself to various format files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on.", "operationId": "PostExport", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "objectType", "in": "query", "description": "Exported object type:workbook/worksheet/chart/comment/picture/shape/listobject/oleobject.", "default": "workbook", "x-nullable": true }, { "type": "string", "name": "format", "in": "query", "description": "The conversion format(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers).", "default": "Xlsx", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/exportxml": { "post": { "tags": [ "DataProcessing" ], "summary": "Export XML data from an Excel file.\nWhen there are XML Maps in an Excel file, export XML data. When there is no XML map in the Excel file, convert the Excel file to an XML file.", "description": " Aspose.Cells Cloud provides robust support for exporting XML data from an Excel file, a process known for its intricacy. When there are XML Maps in an Excel file, export XML data. When there is no XML map in the Excel file, convert the Excel file to an XML file.", "operationId": "PostWorkbookExportXML", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "description": "Path to save the result. If it's a single file, the `outPath` should encompass both the filename and extension. In the case of multiple files, the `outPath` should only include the folder.", "x-nullable": true }, { "type": "string", "name": "outStorageName", "in": "query", "description": "The storage name where the output file is situated.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "If an output directory is specified, a CellsCloudFileInfoResponse is returned; otherwise, a file stream is returned. \nor\nReturns 200 if the copy is successful.", "schema": {}, "x-expectedSchemas": [ { "description": "If an output directory is specified, a CellsCloudFileInfoResponse is returned; otherwise, a file stream is returned. ", "schema": { "$ref": "#/definitions/Stream" } }, { "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudFileInfoResponse" } } ] } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/importjson": { "post": { "tags": [ "DataProcessing" ], "summary": "Import a JSON data file into the workbook. The JSON data file can either be a cloud file or data from an HTTP URI.", "description": " Aspose.Cells Cloud provides robust support for importing Json data into an Excel file, a process known for its intricacy. ", "operationId": "PostWorkbookImportJson", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "importJsonRequest", "in": "body", "required": true, "description": "Import Json request.", "schema": { "$ref": "#/definitions/ImportJsonRequest" }, "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "description": "Path to save the result. If it's a single file, the `outPath` should encompass both the filename and extension. In the case of multiple files, the `outPath` should only include the folder.", "x-nullable": true }, { "type": "string", "name": "outStorageName", "in": "query", "description": "The storage name where the output file is situated.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "If an output directory is specified, a CellsCloudFileInfoResponse is returned; otherwise, a file stream is returned. \nor\nReturns 200 if the copy is successful.", "schema": {}, "x-expectedSchemas": [ { "description": "If an output directory is specified, a CellsCloudFileInfoResponse is returned; otherwise, a file stream is returned. ", "schema": { "$ref": "#/definitions/Stream" } }, { "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudFileInfoResponse" } } ] } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/importxml": { "post": { "tags": [ "DataProcessing" ], "summary": "Import an XML data file into an Excel file. The XML data file can either be a cloud file or data from an HTTP URI.", "description": " Aspose.Cells Cloud provides robust support for importing XML data into an Excel file, a process known for its intricacy. ", "operationId": "PostWorkbookImportXML", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "importXMLRequest", "in": "body", "required": true, "description": "Import XML request.", "schema": { "$ref": "#/definitions/ImportXMLRequest" }, "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "description": "Path to save the result. If it's a single file, the `outPath` should encompass both the filename and extension. In the case of multiple files, the `outPath` should only include the folder.", "x-nullable": true }, { "type": "string", "name": "outStorageName", "in": "query", "description": "The storage name where the output file is situated.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "If an output directory is specified, a CellsCloudFileInfoResponse is returned; otherwise, a file stream is returned. \nor\nReturns 200 if the copy is successful.", "schema": {}, "x-expectedSchemas": [ { "description": "If an output directory is specified, a CellsCloudFileInfoResponse is returned; otherwise, a file stream is returned. ", "schema": { "$ref": "#/definitions/Stream" } }, { "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudFileInfoResponse" } } ] } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/importdata": { "post": { "tags": [ "DataProcessing" ], "summary": "Import data into the Excel file.", "description": " Aspose.Cells Cloud provides robust support for importing data into the Excel file, a process known for its intricacy. Aspose.Cells Cloud support the import of data in a variety of formats.", "operationId": "PostImportData", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "importOption", "in": "body", "required": true, "description": "Import option. They are include of ImportCSVDataOption, ImportBatchDataOption, ImportPictureOption, ImportStringArrayOption, Import2DimensionStringArrayOption, and so on. ", "schema": { "$ref": "#/definitions/ImportOption" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/datacleansing": { "post": { "tags": [ "DataProcessing" ], "summary": "Data cleaning of spreadsheet files is a data management process used to identify, correct, and remove errors, incompleteness, duplicates, or inaccuracies in tables and ranges.", "description": " Aspose.Cells Cloud provides robust support for data cleaning of Spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostWorkbookDataCleansing", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "dataCleansing", "in": "body", "required": true, "description": "data cleansing content.", "schema": { "$ref": "#/definitions/DataCleansing" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The file password. ", "x-nullable": true }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/datacleansing": { "post": { "tags": [ "DataProcessing" ], "summary": "Data cleansing of spreadsheet files is a data management process used to identify, correct, and remove errors, incompleteness, duplicates, or inaccuracies in tables and ranges.", "description": " Aspose.Cells Cloud provides robust support for data cleansing of spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostDataCleansing", "parameters": [ { "name": "dataCleansingRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DataCleansingRequest" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/datadeduplication": { "post": { "tags": [ "DataProcessing" ], "summary": "Data deduplication of spreadsheet files is mainly used to eliminate duplicate data in tables and ranges.", "description": " Aspose.Cells Cloud provides robust support for data deduplication of spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostWorkbookDataDeduplication", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "name": "deduplicationRegion", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeduplicationRegion" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "x-nullable": true }, { "type": "string", "name": "region", "in": "query", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/datadeduplication": { "post": { "tags": [ "DataProcessing" ], "summary": "Data deduplication of spreadsheet files is mainly used to eliminate duplicate data in tables and ranges.", "description": " Aspose.Cells Cloud provides robust support for data deduplication of spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostDataDeduplication", "parameters": [ { "name": "dataDeduplicationRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DataDeduplicationRequest" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/datafill": { "post": { "tags": [ "DataProcessing" ], "summary": "Data filling for spreadsheet files is primarily used to fill empty data in tables and ranges.", "description": " Aspose.Cells Cloud provides robust support for data filling of spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostWorkbookDataFill", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "name": "dataFill", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DataFill" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "x-nullable": true }, { "type": "string", "name": "region", "in": "query", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/datafill": { "post": { "tags": [ "DataProcessing" ], "summary": "Data filling for spreadsheet files is primarily used to fill empty data in tables and ranges.", "description": " Aspose.Cells Cloud provides robust support for data filling of spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostDataFill", "parameters": [ { "name": "dataFillRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DataFillRequest" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/deleteincompleterows": { "post": { "tags": [ "DataProcessing" ], "summary": "Deleting incomplete rows of spreadsheet files is mainly used to eliminate incomplete rows in tables and ranges.", "description": " Aspose.Cells Cloud provides robust support for deleting incomplete rows of spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostDeleteIncompleteRows", "parameters": [ { "name": "deleteIncompleteRowsRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeleteIncompleteRowsRequest" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/datatransformation": { "post": { "tags": [ "DataProcessing" ], "summary": "Transform spreadsheet data is mainly used to pivot columns, unpivot columns. ", "description": " Aspose.Cells Cloud provides robust support for transforming data of spreadsheet files, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, ODS, and so on. ", "operationId": "PostDataTransformation", "parameters": [ { "name": "dataTransformationRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DataTransformationRequest" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/hyperlinks": { "get": { "tags": [ "Hypelinks" ], "summary": "Retrieve descriptions of hyperlinks in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of hyperlinks in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetHyperlinks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/HyperlinksResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Hypelinks" ], "summary": "Add hyperlink in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding hyperlink in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetHyperlink", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "firstRow", "in": "query", "required": true, "description": "First row of the hyperlink range.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "firstColumn", "in": "query", "required": true, "description": "First column of the hyperlink range.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalRows", "in": "query", "required": true, "description": "Number of rows in this hyperlink range.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "totalColumns", "in": "query", "required": true, "description": "Number of columns of this hyperlink range.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "address", "in": "query", "required": true, "description": "Address of the hyperlink.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Hypelinks" ], "summary": "Delete all hyperlinks in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting all hyperlinks in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetHyperlinks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/hyperlinks/{hyperlinkIndex}": { "get": { "tags": [ "Hypelinks" ], "summary": "Retrieve hyperlink description by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining hyperlink description by index in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetHyperlink", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "hyperlinkIndex", "in": "path", "required": true, "description": "The hyperlink's index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/HyperlinkResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Hypelinks" ], "summary": "Delete hyperlink by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting hyperlink by index in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetHyperlink", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "hyperlinkIndex", "in": "path", "required": true, "description": "The hyperlink's index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Hypelinks" ], "summary": "Update hyperlink by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating hyperlink by index in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetHyperlink", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "hyperlinkIndex", "in": "path", "required": true, "description": "The hyperlink's index.", "format": "int32", "x-nullable": false }, { "name": "hyperlink", "in": "body", "required": true, "description": "Hyperlink object", "schema": { "$ref": "#/definitions/Hyperlink" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/assemble": { "post": { "tags": [ "LightCells" ], "summary": "Assemble data files with template files to generate files in various formats.", "description": " Aspose.Cells Cloud provides robust support for assembling data files with template files to generate files in various formats, a process known for its intricacy. Aspose.Cells Cloud supports 30+ file formats, including Excel, Pdf, Markdown, Json, XML, Csv, Html, and so on.", "operationId": "PostAssemble", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "datasource", "in": "query", "required": true, "x-nullable": true }, { "type": "string", "name": "outFormat", "in": "query", "description": "The format to convert(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "default": "Xlsx", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/compress": { "post": { "tags": [ "LightCells" ], "summary": "Compress files and generate target files in various formats, supported file formats are include Xls, Xlsx, Xlsm, Xlsb, Ods and more.", "description": " Aspose.Cells Cloud provides robust support for compressing Excel files to generate target files in various formats, a process known for its intricacy. ", "operationId": "PostCompress", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "integer", "name": "CompressLevel", "in": "query", "description": "Compress level. The compression ratio 1-100.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/merge": { "post": { "tags": [ "LightCells" ], "summary": "Merge multiple Excel files into a single file, and generate output files in different formats.", "description": " Aspose.Cells Cloud provides robust support for merging multiple Excel files into a single file and generating output files in different formats, a process known for its intricacy. ", "operationId": "PostMerge", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "boolean", "name": "mergeToOneSheet", "in": "query", "description": "Merge all workbooks into a sheet. ", "default": false, "x-nullable": false }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "File", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FileInfo ", "schema": { "$ref": "#/definitions/FileInfo" } } }, "security": [ { "JWT": [] } ] } }, "/cells/split": { "post": { "tags": [ "LightCells" ], "summary": "Split Excel spreadsheet files based on worksheets and create output files in various formats.", "description": " Aspose.Cells Cloud provides robust support for splitting Excel spreadsheet files based on worksheets and create output files in various formats, a process known for its intricacy. ", "operationId": "PostSplit", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outFormat", "in": "query", "required": true, "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "integer", "name": "from", "in": "query", "description": "sheet index", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "to", "in": "query", "description": "sheet index", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/search": { "post": { "tags": [ "LightCells" ], "summary": "Search for specified text within Excel files.", "description": " Indeed, Aspose.Cells Cloud offers strong support for searching specified text within Excel files.", "operationId": "PostSearch", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "text", "in": "query", "required": true, "description": "Find content", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "string", "name": "sheetname", "in": "query", "description": "The worksheet name. Locate the specified text content in the worksheet.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TextItem" } } } }, "security": [ { "JWT": [] } ] } }, "/cells/replace": { "post": { "tags": [ "LightCells" ], "summary": "Replace specified text with new text in Excel files.", "description": " Indeed, Aspose.Cells Cloud offers strong support for replacing specified text with new text in Excel files.", "operationId": "PostReplace", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "text", "in": "query", "required": true, "description": "Find content", "x-nullable": true }, { "type": "string", "name": "newtext", "in": "query", "required": true, "description": "Replace content", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "string", "name": "sheetname", "in": "query", "description": "The worksheet name. Locate the specified text content in the worksheet.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "file", "name": "File", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/import": { "post": { "tags": [ "LightCells" ], "summary": "Import data into an Excel file and generate output files in various formats.", "description": " Indeed, Aspose.Cells Cloud offers strong support for importing data into an Excel file and generating output files in various formats.", "operationId": "PostImport", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "File", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult Text item list. ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/watermark": { "post": { "tags": [ "LightCells" ], "summary": "Add Text Watermark to Excel files and generate output files in various formats.", "description": " Indeed, Aspose.Cells Cloud offers strong support for adding text watermark to Excel files and generating output files in various formats.", "operationId": "PostWatermark", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "text", "in": "query", "required": true, "description": "background text.", "x-nullable": true }, { "type": "string", "name": "color", "in": "query", "required": true, "description": "e.g. #1032ff", "x-nullable": true }, { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/clearobjects": { "post": { "tags": [ "LightCells" ], "summary": "Clear internal elements in Excel files and generate output files in various formats.", "description": " Indeed, Aspose.Cells Cloud offers strong support for clearing internal elements in Excel files and generating output files in various formats.", "operationId": "PostClearObjects", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "objecttype", "in": "query", "required": true, "description": "chart/comment/picture/shape/listobject/hyperlink/oleobject/pivottable/validation/Background", "x-nullable": true }, { "type": "string", "name": "sheetname", "in": "query", "description": "The worksheet name, specify the scope of the deletion.", "x-nullable": true }, { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/reverse": { "post": { "tags": [ "LightCells" ], "summary": "Reverse rows or columns in Excel files and create output files in various formats.", "description": " Indeed, Aspose.Cells Cloud offers strong support for clearing internal elements in Excel files and generating output files in various formats.", "operationId": "PostReverse", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "rotateType", "in": "query", "required": true, "description": "rows/cols/both", "x-nullable": true }, { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/repair": { "post": { "tags": [ "LightCells" ], "summary": "Repair abnormal files and generate files in various formats. ", "description": " Indeed, Aspose.Cells Cloud offers strong support for repairing abnormal files and generating files in various formats.", "operationId": "PostRepair", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/rotate": { "post": { "tags": [ "LightCells" ], "summary": "Rotate rows, columns, or other objects in Excel files and save them in various formats.", "description": " Indeed, Aspose.Cells Cloud offers strong support for rotating rows, columns, or other objects in Excel files and saving them in various formats.", "operationId": "PostRotate", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "rotateType", "in": "query", "required": true, "description": "270/90/row/col/row2col", "x-nullable": true }, { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/metadata/update": { "post": { "tags": [ "LightCells" ], "summary": "Update document properties in Excel file, and save them is various formats.", "description": " Indeed, Aspose.Cells Cloud offers strong support for updating document properties in Excel file and saving them is various formats.", "operationId": "PostMetadata", "consumes": [ "multipart/form-data" ], "produces": [ "multipart/form-data" ], "parameters": [ { "name": "cellsDocuments", "in": "body", "required": true, "description": "document properties", "schema": { "type": "array", "items": { "$ref": "#/definitions/CellsDocumentProperty" } }, "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "region", "in": "query", "description": "The regional settings for workbook.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/metadata/get": { "post": { "tags": [ "LightCells" ], "summary": "Get cells document properties.", "description": " Indeed, Aspose.Cells Cloud offers strong support for getting cells document properties.", "operationId": "GetMetadata", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "type", "in": "query", "description": "Cells document property name.", "default": "all", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "CellsDocumentProperty Cells DocumentProperty list. ", "schema": { "type": "array", "items": { "$ref": "#/definitions/CellsDocumentProperty" } } } }, "security": [ { "JWT": [] } ] } }, "/cells/metadata/delete": { "post": { "tags": [ "LightCells" ], "summary": "Delete cells document properties in Excel file, and save them is various formats.", "description": " Indeed, Aspose.Cells Cloud offers strong support for deleting cells document properties in Excel file and save them is various formats.", "operationId": "DeleteMetadata", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "type", "in": "query", "description": "Cells document property name.", "default": "all", "x-nullable": true }, { "type": "string", "name": "outFormat", "in": "query", "description": "The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "boolean", "name": "checkExcelRestriction", "in": "query", "description": "Whether check restriction of excel file when user modify cells related objects.", "default": true, "x-nullable": false }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult ", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects": { "get": { "tags": [ "ListObjects" ], "summary": "Retrieve descriptions of ListObjects in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of ListObjects in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetListObjects", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ListObjectsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "ListObjects" ], "summary": "Add a ListObject in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a ListObject in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetListObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startRow", "in": "query", "description": "The start row of the list range.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "startColumn", "in": "query", "description": "The start column of the list range.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endRow", "in": "query", "description": "The start row of the list range.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endColumn", "in": "query", "description": "The start column of the list range.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "boolean", "name": "hasHeaders", "in": "query", "description": "Indicate whether the range has headers.", "default": true, "x-nullable": false }, { "type": "string", "name": "displayName", "in": "query", "description": "Indicate whether display name.", "x-nullable": true }, { "type": "boolean", "name": "showTotals", "in": "query", "description": "Indicate whether show totals.", "default": false, "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "ListObjects" ], "summary": "Delete ListObjects in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting ListObjects in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetListObjects", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listobjectindex}": { "get": { "tags": [ "ListObjects" ], "summary": "Retrieve list object description by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining list object description by index in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetListObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listobjectindex", "in": "path", "required": true, "description": "list object index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}": { "delete": { "tags": [ "ListObjects" ], "summary": "Delete list object by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting list object by index in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetListObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "List object index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "ListObjects" ], "summary": "Update list object by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating list object by index in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetListObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "list Object index", "format": "int32", "x-nullable": false }, { "name": "listObject", "in": "body", "required": true, "description": "listObject dto in request body.", "schema": { "$ref": "#/definitions/ListObject" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/ConvertToRange": { "post": { "tags": [ "ListObjects" ], "summary": "Convert list object to range in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for converting list object to range in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetListObjectConvertToRange", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "List object index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/SummarizeWithPivotTable": { "post": { "tags": [ "ListObjects" ], "summary": "Create a pivot table with a list object in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for creating a pivot table with a list object in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetListObjectSummarizeWithPivotTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "The list object index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "destsheetName", "in": "query", "required": true, "description": "The target worksheet name.", "x-nullable": true }, { "name": "createPivotTableRequest", "in": "body", "required": true, "description": "Create pivot table request.", "schema": { "$ref": "#/definitions/CreatePivotTableRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/sort": { "post": { "tags": [ "ListObjects" ], "summary": "Sort list object in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for sorting list object in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetListObjectSortTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "The list object index.", "format": "int32", "x-nullable": false }, { "name": "dataSorter", "in": "body", "required": true, "description": "Represents sort order for the data range.", "schema": { "$ref": "#/definitions/DataSorter" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/RemoveDuplicates": { "post": { "tags": [ "ListObjects" ], "summary": "Remove duplicates in list object.", "description": " Aspose.Cells Cloud provides robust support for removing duplicates in list object, a process known for its intricacy. ", "operationId": "PostWorksheetListObjectRemoveDuplicates", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "The list object index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/InsertSlicer": { "post": { "tags": [ "ListObjects" ], "summary": "Insert slicer for list object.", "description": " Aspose.Cells Cloud provides robust support for inserting slicer for list object, a process known for its intricacy. ", "operationId": "PostWorksheetListObjectInsertSlicer", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "List object index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "columnIndex", "in": "query", "required": true, "description": "The index of ListColumn in ListObject.ListColumns ", "format": "int32", "x-nullable": false }, { "type": "string", "name": "destCellName", "in": "query", "required": true, "description": "The cell in the upper-left corner of the Slicer range. ", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/listcolumns/{columnIndex}": { "post": { "tags": [ "ListObjects" ], "summary": "Update list column in list object.", "description": " Aspose.Cells Cloud provides robust support for updating list column in list object, a process known for its intricacy. ", "operationId": "PostWorksheetListColumn", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "The list object index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "columnIndex", "in": "path", "required": true, "description": "Represents table column index.", "format": "int32", "x-nullable": false }, { "name": "listColumn", "in": "body", "required": true, "description": "Represents table column description.", "schema": { "$ref": "#/definitions/ListColumn" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/listcolumns/total": { "post": { "tags": [ "ListObjects" ], "summary": "Update total of list columns in the table.", "description": " Aspose.Cells Cloud provides robust support for updating total of list columns in the table, a process known for its intricacy. ", "operationId": "PostWorksheetListColumnsTotal", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "listObjectIndex", "in": "path", "required": true, "description": "List object index.", "format": "int32", "x-nullable": false }, { "name": "tableTotalRequests", "in": "body", "required": true, "description": "Represents table column description.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TableTotalRequest" } }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/oleobjects": { "get": { "tags": [ "OleObjects" ], "summary": "Retrieve descriptions of OLE objects in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of OLE objects in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetOleObjects", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/OleObjectsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "OleObjects" ], "summary": "Delete all OLE objects in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting all OLE objects in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetOleObjects", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worsheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "OleObjects" ], "summary": "Add an OLE object in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding an OLE object in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetOleObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worsheet name.", "x-nullable": false }, { "type": "integer", "name": "upperLeftRow", "in": "query", "description": "Upper left row index", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "upperLeftColumn", "in": "query", "description": "Upper left column index", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "height", "in": "query", "description": "Height of oleObject, in unit of pixel", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "Width of oleObject, in unit of pixel", "format": "int32", "default": 0, "x-nullable": false }, { "type": "string", "name": "oleFile", "in": "query", "description": "OLE filename path(full file name).", "x-nullable": true }, { "type": "string", "name": "imageFile", "in": "query", "description": "Image filename path(full file name).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/oleobjects/{objectNumber}": { "get": { "tags": [ "OleObjects" ], "summary": "Retrieve the OLE object in a specified format in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining the OLE object in a specified format in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetOleObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "objectNumber", "in": "path", "required": true, "description": "The object number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "description": "Object conversion format(PNG/TIFF/JPEG/GIF/EMF/BMP).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/oleobjects/{oleObjectIndex}": { "delete": { "tags": [ "OleObjects" ], "summary": "Delete an OLE object in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting an OLE object in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetOleObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worsheet name.", "x-nullable": false }, { "type": "integer", "name": "oleObjectIndex", "in": "path", "required": true, "description": "Ole object index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "OleObjects" ], "summary": "Update an OLE object in worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting an OLE object in the worksheet, a process known for its intricacy. ", "operationId": "PostUpdateWorksheetOleObject", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worsheet name.", "x-nullable": false }, { "type": "integer", "name": "oleObjectIndex", "in": "path", "required": true, "description": "Ole object index.", "format": "int32", "x-nullable": false }, { "name": "ole", "in": "body", "required": true, "description": "Ole Object description.", "schema": { "$ref": "#/definitions/OleObject" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/verticalpagebreaks": { "get": { "tags": [ "PageBreaks" ], "summary": "Retrieve descriptions of vertical page breaks in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of vertical page breaks in the worksheet, a process known for its intricacy.", "operationId": "GetVerticalPageBreaks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/VerticalPageBreaksResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "PageBreaks" ], "summary": "Add a vertical page break in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a vertical page break in the worksheet, a process known for its intricacy. ", "operationId": "PutVerticalPageBreak", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellname", "in": "query", "description": "Cell name", "x-nullable": true }, { "type": "integer", "name": "column", "in": "query", "description": "Column index, zero based.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "row", "in": "query", "description": "Row index, zero based.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "startRow", "in": "query", "description": "Start row index, zero based.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endRow", "in": "query", "description": "End row index, zero based.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "PageBreaks" ], "summary": "Delete vertical page breaks in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting vertical page breaks in the worksheet, a process known for its intricacy. ", "operationId": "DeleteVerticalPageBreaks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "column", "in": "query", "description": "Column index, zero based.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/horizontalpagebreaks": { "get": { "tags": [ "PageBreaks" ], "summary": "Retrieve descriptions of horizontal page breaks in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of horizontal page breaks in the worksheet, a process known for its intricacy. ", "operationId": "GetHorizontalPageBreaks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/HorizontalPageBreaksResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "PageBreaks" ], "summary": "Add a horizontal page breaks in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a horizontal page break in the worksheet, a process known for its intricacy. ", "operationId": "PutHorizontalPageBreak", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellname", "in": "query", "description": "Cell name", "x-nullable": true }, { "type": "integer", "name": "row", "in": "query", "description": "Row index, zero based.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "column", "in": "query", "description": "Column index, zero based.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "startColumn", "in": "query", "description": "Start column index, zero based.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endColumn", "in": "query", "description": "End column index, zero based.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "PageBreaks" ], "summary": "Delete horizontal page breaks in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting horizontal page breaks in the worksheet, a process known for its intricacy. ", "operationId": "DeleteHorizontalPageBreaks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "row", "in": "query", "description": "Row index, zero based.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/verticalpagebreaks/{index}": { "get": { "tags": [ "PageBreaks" ], "summary": "Retrieve a vertical page break description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining a vertical page break description in the worksheet, a process known for its intricacy. ", "operationId": "GetVerticalPageBreak", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "The zero based index of the element.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/VerticalPageBreakResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "PageBreaks" ], "summary": "Delete a vertical page break in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a vertical page break in the worksheet, a process known for its intricacy. ", "operationId": "DeleteVerticalPageBreak", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "Removes the vertical page break element at a specified name. Element index, zero based.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/horizontalpagebreaks/{index}": { "get": { "tags": [ "PageBreaks" ], "summary": "Retrieve a horizontal page break descripton in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining a horizontal page break description in the worksheet, a process known for its intricacy. ", "operationId": "GetHorizontalPageBreak", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "The zero based index of the element.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/HorizontalPageBreakResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "PageBreaks" ], "summary": "Delete a horizontal page break in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a horizontal page break in the worksheet, a process known for its intricacy. ", "operationId": "DeleteHorizontalPageBreak", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "index", "in": "path", "required": true, "description": "Removes the horizontal page break element at a specified name. Element index, zero based.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pagesetup": { "get": { "tags": [ "PageSetup" ], "summary": "Retrieve page setup description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining page setup description in the worksheet, a process known for its intricacy.", "operationId": "GetPageSetup", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PageSetupResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "PageSetup" ], "summary": "Update page setup in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating page setup in the worksheet, a process known for its intricacy. ", "operationId": "PostPageSetup", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "pageSetup", "in": "body", "required": true, "description": "PageSetup Page Setup description.", "schema": { "$ref": "#/definitions/PageSetup" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pagesetup/clearheaderfooter": { "delete": { "tags": [ "PageSetup" ], "summary": "Clear header and footer in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for clearing header and footer in the worksheet in the worksheet, a process known for its intricacy. ", "operationId": "DeleteHeaderFooter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pagesetup/header": { "get": { "tags": [ "PageSetup" ], "summary": "Retrieve page header description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining page header description in the worksheet in the worksheet, a process known for its intricacy. ", "operationId": "GetHeader", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PageSectionsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "PageSetup" ], "summary": "Update page header in the worksheet. ", "description": " Aspose.Cells Cloud provides robust support for updating page header in the worksheet in the worksheet, a process known for its intricacy. ", "operationId": "PostHeader", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "section", "in": "query", "required": true, "description": "0:Left Section. 1:Center Section 2:Right Section", "format": "int32", "x-nullable": false }, { "type": "string", "name": "script", "in": "query", "required": true, "description": "Header format script.", "x-nullable": true }, { "type": "boolean", "name": "isFirstPage", "in": "query", "required": true, "description": "Is first page(true/false).", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pagesetup/footer": { "get": { "tags": [ "PageSetup" ], "summary": "Retrieve page footer description in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining page footer description in the worksheet in the worksheet, a process known for its intricacy. ", "operationId": "GetFooter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PageSectionsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "PageSetup" ], "summary": "Update page footer in the worksheet. ", "description": " Aspose.Cells Cloud provides robust support for updating page footer in the worksheet, a process known for its intricacy. ", "operationId": "PostFooter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "section", "in": "query", "required": true, "description": "0:Left Section. 1:Center Section 2:Right Section", "format": "int32", "x-nullable": false }, { "type": "string", "name": "script", "in": "query", "required": true, "description": "Header format script.", "x-nullable": true }, { "type": "boolean", "name": "isFirstPage", "in": "query", "required": true, "description": "Is first page(true/false).", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pagesetup/fitwidetopages": { "post": { "tags": [ "PageSetup" ], "summary": "Set the scale at which the page will fit wide when printed on the sheet.", "description": " Aspose.Cells Cloud provides robust support for setting the scale at which the page will fit wide when printed on the sheet, a process known for its intricacy. ", "operationId": "PostFitWideToPages", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pagesetup/fittalltopages": { "post": { "tags": [ "PageSetup" ], "summary": "Set the scale at which the page will fit tall when printed on the sheet.", "description": " Aspose.Cells Cloud provides robust support for setting the scale at which the page will fit tall when printed on the sheet, a process known for its intricacy. ", "operationId": "PostFitTallToPages", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pictures": { "get": { "tags": [ "Pictures" ], "summary": "Retrieve descriptions of pictures in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of pictures in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetPictures", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PicturesResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pictures" ], "summary": "Add a new picture in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a picture in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetAddPicture", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worsheet name.", "x-nullable": false }, { "name": "picture", "in": "body", "required": true, "description": "Pictute object", "schema": { "$ref": "#/definitions/Picture" }, "x-nullable": true }, { "type": "integer", "name": "upperLeftRow", "in": "query", "description": "The image upper left row.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "upperLeftColumn", "in": "query", "description": "The image upper left column.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "lowerRightRow", "in": "query", "description": "The image low right row.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "lowerRightColumn", "in": "query", "description": "The image low right column.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "picturePath", "in": "query", "description": "The picture path, if not provided the picture data is inspected in the request body.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Pictures" ], "summary": "Delete all pictures in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting all pictures in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetPictures", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pictures/{pictureNumber}": { "get": { "tags": [ "Pictures" ], "summary": "Retrieve a picture by number in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining a picture by number in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetPictureWithFormat", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pictureNumber", "in": "path", "required": true, "description": "The picture index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "required": true, "description": "Picture conversion format(PNG/TIFF/JPEG/GIF/EMF/BMP).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pictures/addPictureInCell": { "post": { "tags": [ "Pictures" ], "summary": "add new picture in the cells.", "operationId": "AddPictureInCell", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "x-nullable": false }, { "type": "string", "name": "cellName", "in": "query", "required": true, "x-nullable": true }, { "type": "string", "name": "picturePath", "in": "query", "required": true, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pictures/{pictureIndex}": { "post": { "tags": [ "Pictures" ], "summary": "Update a picture by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating a picture by index in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetPicture", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pictureIndex", "in": "path", "required": true, "description": "The picture's index.", "format": "int32", "x-nullable": false }, { "name": "picture", "in": "body", "required": true, "description": "Picture object description.", "schema": { "$ref": "#/definitions/Picture" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Pictures" ], "summary": "Delete a picture object by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating a picture by index in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetPicture", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worsheet name.", "x-nullable": false }, { "type": "integer", "name": "pictureIndex", "in": "path", "required": true, "description": "Picture index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables": { "get": { "tags": [ "PivotTables" ], "summary": "Retrieve descriptions of pivottables in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of pivottables in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetPivotTables", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PivotTablesResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "PivotTables" ], "summary": "Add a PivotTable in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a PivotTable in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetPivotTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "sourceData", "in": "query", "description": "The data for the new PivotTable cache.", "x-nullable": true }, { "type": "string", "name": "destCellName", "in": "query", "description": "The cell in the upper-left corner of the destination range for the PivotTable report.", "x-nullable": true }, { "type": "string", "name": "tableName", "in": "query", "description": "The name of the new PivotTable.", "x-nullable": true }, { "type": "boolean", "name": "useSameSource", "in": "query", "description": "Indicates whether using same data source when another existing PivotTable has used this data source. If the property is true, it will save memory.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "PivotTables" ], "summary": "Delete PivotTables in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting PivotTables in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetPivotTables", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivottableIndex}": { "get": { "tags": [ "PivotTables" ], "summary": "Retrieve PivotTable information by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining PivotTable information by index in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetPivotTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivottableIndex", "in": "path", "required": true, "description": "Gets the PivotTable report by index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PivotTableResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField": { "get": { "tags": [ "PivotTables" ], "summary": "Retrieve descriptions of pivot fields in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of pivot fields in the PivotTable, a process known for its intricacy. ", "operationId": "GetPivotTableField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "pivotFieldIndex", "in": "query", "required": true, "description": "The pivot field index of PivotTable.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "pivotFieldType", "in": "query", "required": true, "description": "The field area type(column/row).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PivotFieldResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "PivotTables" ], "summary": "Add a pivot field in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for adding a PivotTable in the worksheet, a process known for its intricacy. ", "operationId": "PutPivotTableField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "pivotFieldType", "in": "query", "required": true, "description": "The fields area type.", "x-nullable": true }, { "name": "pivotTableFieldRequest", "in": "body", "required": true, "description": "PivotTableFieldRequest The PivotTable field request.", "schema": { "$ref": "#/definitions/PivotTableFieldRequest" }, "x-nullable": true }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "PivotTables" ], "summary": "Delete a pivot field in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for deleting a pivot field in the PivotTable, a process known for its intricacy. ", "operationId": "DeletePivotTableField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "Gets the PivotTable report by index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "pivotFieldType", "in": "query", "required": true, "description": "The fields area type.", "x-nullable": true }, { "name": "pivotTableFieldRequest", "in": "body", "required": true, "description": "PivotTableFieldRequest PivotTable field request.", "schema": { "$ref": "#/definitions/PivotTableFieldRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters": { "get": { "tags": [ "PivotTables" ], "summary": "Gets PivotTable filters in worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of pivot fields in the PivotTable, a process known for its intricacy. ", "operationId": "GetWorksheetPivotTableFilters", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PivotFiltersResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "PivotTables" ], "summary": "Add a pivot filter to the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for adding a PivotTable in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetPivotTableFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "Gets the PivotTable report by index.", "format": "int32", "x-nullable": false }, { "name": "filter", "in": "body", "required": true, "description": "PivotFilter Pivot filter description.", "schema": { "$ref": "#/definitions/PivotFilter" }, "x-nullable": true }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "PivotTables" ], "summary": "Delete all pivot filters in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for deleting all pivot filters in the PivotTable, a process known for its intricacy. ", "operationId": "DeleteWorksheetPivotTableFilters", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters/{filterIndex}": { "get": { "tags": [ "PivotTables" ], "summary": "Retrieve PivotTable filters in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of pivot fields in the PivotTable, a process known for its intricacy. ", "operationId": "GetWorksheetPivotTableFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index in the worksheet.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "filterIndex", "in": "path", "required": true, "description": "The pivot filter index of PivotTable.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/PivotFilterResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField/Hide": { "post": { "tags": [ "PivotTables" ], "summary": "Hide a pivot field item in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for hiding a pivot field item in the PivotTable, a process known for its intricacy. ", "operationId": "PostPivotTableFieldHideItem", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "pivotFieldType", "in": "query", "required": true, "description": "Represents PivotTable field type(Undefined/Row/Column/Page/Data).", "x-nullable": true }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The pivot field index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "itemIndex", "in": "query", "required": true, "description": "The index of the pivot item in the pivot field.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "isHide", "in": "query", "required": true, "description": "Whether the specific PivotItem is hidden(true/false).", "x-nullable": false }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField/Move": { "post": { "tags": [ "PivotTables" ], "summary": "Move a pivot field in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for moving a pivot field in the PivotTable, a process known for its intricacy. ", "operationId": "PostPivotTableFieldMoveTo", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "fieldIndex", "in": "query", "required": true, "description": "The pivot field index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "from", "in": "query", "required": true, "description": "The fields area type(Column/Row/Page/Data/Undefined).", "x-nullable": true }, { "type": "string", "name": "to", "in": "query", "required": true, "description": "The fields area type(Column/Row/Page/Data/Undefined).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/Format": { "post": { "tags": [ "PivotTables" ], "summary": "Update cell style in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for updating cell style in the PivotTable, a process known for its intricacy. ", "operationId": "PostPivotTableCellStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "column", "in": "query", "required": true, "description": "The column index of the cell.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "row", "in": "query", "required": true, "description": "The row index of the cell.", "format": "int32", "x-nullable": false }, { "name": "style", "in": "body", "required": true, "description": "Style Style description in request body.", "schema": { "$ref": "#/definitions/Style" }, "x-nullable": true }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/FormatAll": { "post": { "tags": [ "PivotTables" ], "summary": "Update style in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for updating style in the PivotTable, a process known for its intricacy. ", "operationId": "PostPivotTableStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "name": "style", "in": "body", "required": true, "description": "StyleStyle description in request body.", "schema": { "$ref": "#/definitions/Style" }, "x-nullable": true }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFields": { "post": { "tags": [ "PivotTables" ], "summary": "Update pivot fields in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for updating pivot fields in the PivotTable, a process known for its intricacy. ", "operationId": "PostPivotTableUpdatePivotFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "pivotFieldType", "in": "query", "required": true, "description": "Represents PivotTable field type(Undefined/Row/Column/Page/Data).", "x-nullable": true }, { "name": "pivotField", "in": "body", "required": true, "description": "PivotFieldRepresents pivot field.", "schema": { "$ref": "#/definitions/PivotField" }, "x-nullable": true }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFields/{pivotFieldIndex}": { "post": { "tags": [ "PivotTables" ], "summary": "Update pivot field in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for updating pivot field in the PivotTable, a process known for its intricacy. ", "operationId": "PostPivotTableUpdatePivotField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "The PivotTable index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "pivotFieldIndex", "in": "path", "required": true, "description": "The pivot field index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "pivotFieldType", "in": "query", "required": true, "description": "Represents PivotTable field type(Undefined/Row/Column/Page/Data).", "x-nullable": true }, { "name": "pivotField", "in": "body", "required": true, "description": "Represents pivot field.", "schema": { "$ref": "#/definitions/PivotField" }, "x-nullable": true }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/Calculate": { "post": { "tags": [ "PivotTables" ], "summary": "Calculate pivottable's data to cells.", "description": " Aspose.Cells Cloud provides robust support for calculating pivottable's data to cells, a process known for its intricacy. ", "operationId": "PostWorksheetPivotTableCalculate", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "Gets the PivotTable report by index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/Move": { "post": { "tags": [ "PivotTables" ], "summary": "Move PivotTable in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for moving PivotTable in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetPivotTableMove", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "Gets the PivotTable report by index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "row", "in": "query", "description": "Row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "column", "in": "query", "description": "Column index.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "destCellName", "in": "query", "description": "The dest cell name.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}": { "delete": { "tags": [ "PivotTables" ], "summary": "Delete PivotTable by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting PivotTable by index in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetPivotTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "Gets the PivotTable report by index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters/{fieldIndex}": { "delete": { "tags": [ "PivotTables" ], "summary": "Delete a pivot filter in the PivotTable.", "description": " Aspose.Cells Cloud provides robust support for deleting a pivot filter in the PivotTable, a process known for its intricacy. ", "operationId": "DeleteWorksheetPivotTableFilter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "pivotTableIndex", "in": "path", "required": true, "description": "Gets the PivotTable report by index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "fieldIndex", "in": "path", "required": true, "description": "Gets the PivotField Object at the specific index.", "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "needReCalculate", "in": "query", "description": "Whether the specific PivotTable calculate(true/false).", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/documentproperties": { "get": { "tags": [ "Properties" ], "summary": "Retrieve descriptions of Excel file properties.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of Excel file properties, a process known for its intricacy.", "operationId": "GetDocumentProperties", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "type", "in": "query", "description": "Excel property type.", "default": "All", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsDocumentPropertiesResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Properties" ], "summary": "Set or add an Excel property.", "description": " Aspose.Cells Cloud provides robust support for setting or adding an Excel property, a process known for its intricacy. ", "operationId": "PutDocumentProperty", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "name": "property", "in": "body", "required": true, "description": "Get or set the value of the property.", "schema": { "$ref": "#/definitions/CellsDocumentProperty" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Properties" ], "summary": "Delete all custom document properties and reset built-in ones.", "description": " Aspose.Cells Cloud provides robust support for deleting all custom document properties and resetting built-in ones, a process known for its intricacy. ", "operationId": "DeleteDocumentProperties", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/documentproperties/{propertyName}": { "get": { "tags": [ "Properties" ], "summary": "Get Excel property by name.", "description": " Aspose.Cells Cloud provides robust support for getting Excel property by name, a process known for its intricacy. ", "operationId": "GetDocumentProperty", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "propertyName", "in": "path", "required": true, "description": "The property name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsDocumentPropertyResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Properties" ], "summary": "Delete an Excel property.", "description": " Aspose.Cells Cloud provides robust support for deleting an Excel property by name, a process known for its intricacy. ", "operationId": "DeleteDocumentProperty", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "propertyName", "in": "path", "required": true, "description": "The property name.", "x-nullable": false }, { "type": "string", "name": "type", "in": "query", "default": "All", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/digitalsignature": { "post": { "tags": [ "Protection" ], "summary": "Excel file digital signature.", "description": " Aspose.Cells Cloud provides robust support for Excel file digital signature, a process that is an electronic, encrypted, stamp of authentication on Excel files.", "operationId": "PostDigitalSignature", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "digitalsignaturefile", "in": "query", "required": true, "description": "The digital signature file path should include both the folder and the file name, along with the extension.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "required": true, "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the digital signature is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/encryption": { "post": { "tags": [ "Protection" ], "summary": "Excel Encryption.", "description": " Aspose.Cells Cloud provides robust support for Excel file encryption, a process that is an important part of your Excel file protection and information protection strategy. ", "operationId": "PostEncryptWorkbook", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "encryption", "in": "body", "required": true, "description": "WorkbookEncryptionRequestEncryption parameters.", "schema": { "$ref": "#/definitions/WorkbookEncryptionRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Protection" ], "summary": "Excel files decryption.", "description": " Aspose.Cells Cloud provides robust support for Excel file decryption. ", "operationId": "DeleteDecryptWorkbook", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "encryption", "in": "body", "required": true, "description": "WorkbookEncryptionRequestEncryption parameters.", "schema": { "$ref": "#/definitions/WorkbookEncryptionRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/protection": { "post": { "tags": [ "Protection" ], "summary": "Excel protection.", "description": " Aspose.Cells Cloud provides robust support for Excel file protection, a process that is an important part of your Excel file protection and information protection strategy. ", "operationId": "PostProtectWorkbook", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "protectWorkbookRequest", "in": "body", "required": true, "description": "The protection settings.", "schema": { "$ref": "#/definitions/ProtectWorkbookRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Protection" ], "summary": "Excel unprotection.", "description": " Aspose.Cells Cloud provides robust support for Excel file unprotection. ", "operationId": "DeleteUnProtectWorkbook", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "password", "in": "query", "required": true, "description": "Protection settings, only password can be specified.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/writeProtection": { "put": { "tags": [ "Protection" ], "summary": "Excel file write protection.", "description": " Aspose.Cells Cloud provides robust support for Excel file unprotection. ", "operationId": "PutDocumentProtectFromChanges", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "password", "in": "body", "required": true, "description": "The password needed to open an Excel file.", "schema": { "$ref": "#/definitions/PasswordRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Protection" ], "summary": "Excel file cancel write protection.", "description": " Aspose.Cells Cloud provides robust support for Excel file cancel write protection. ", "operationId": "DeleteDocumentUnProtectFromChanges", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/unlock": { "post": { "tags": [ "Protection" ], "summary": "Unlock Excel files.", "description": " Aspose.Cells Cloud provides robust support for unlocking Excel files. ", "operationId": "PostUnlock", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "password", "in": "query", "required": true, "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/lock": { "post": { "tags": [ "Protection" ], "summary": "Lock Excel files.", "description": " Aspose.Cells Cloud provides robust support for locking Excel files. ", "operationId": "PostLock", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "password", "in": "query", "required": true, "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "FilesResult", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/protect": { "post": { "tags": [ "Protection" ], "summary": "Excel files encryption.", "description": " Aspose.Cells Cloud provides robust support for Excel file encryption, a process that is an important part of your Excel file protection and information protection strategy. ", "operationId": "PostProtect", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "object", "name": "protectWorkbookRequest", "in": "formData", "x-schema": { "$ref": "#/definitions/ProtectWorkbookRequest" }, "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password needed to open an Excel file.", "x-nullable": true }, { "type": "file", "name": "LocalPath", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/FilesResult" } } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/copy": { "post": { "tags": [ "Ranges" ], "summary": "Copy content from the source range to the destination range in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for copying content from the source range to the destination range in the worksheet, a process known for its intricacy.", "operationId": "PostWorksheetCellsRangesCopy", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "rangeOperate", "in": "body", "required": true, "description": "RangeCopyRequestcopydata,copystyle,copyto,copyvalue", "schema": { "$ref": "#/definitions/RangeCopyRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/merge": { "post": { "tags": [ "Ranges" ], "summary": "Merge a range of cells into a single cell. ", "description": " Aspose.Cells Cloud provides robust support for merging a range of cells into a single cell in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeMerge", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "range", "in": "body", "required": true, "description": "Rangerange description.", "schema": { "$ref": "#/definitions/Range" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/unmerge": { "post": { "tags": [ "Ranges" ], "summary": "Unmerge merged cells within this range.", "description": " Aspose.Cells Cloud provides robust support for unmerging merged cells within this range in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeUnMerge", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "range", "in": "body", "required": true, "description": "Range range description.", "schema": { "$ref": "#/definitions/Range" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/style": { "post": { "tags": [ "Ranges" ], "summary": "Set the style for the specified range.", "description": " Aspose.Cells Cloud provides robust support for setting the style for the specified range in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "rangeOperate", "in": "body", "required": true, "description": "RangeSetStyleRequest Range Set Style Request ", "schema": { "$ref": "#/definitions/RangeSetStyleRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/value": { "get": { "tags": [ "Ranges" ], "summary": "Retrieve the values of cells within the specified range.", "description": " Aspose.Cells Cloud provides robust support for obtaining the values of cells within the specified range in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetCellsRangeValue", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "namerange", "in": "query", "description": "The range name.", "x-nullable": true }, { "type": "integer", "name": "firstRow", "in": "query", "description": "Gets the index of the first row of the range.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "firstColumn", "in": "query", "description": "Gets the index of the first columnn of the range.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "rowCount", "in": "query", "description": "Gets the count of rows in the range.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "columnCount", "in": "query", "description": "Gets the count of columns in the range.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/RangeValueResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Ranges" ], "summary": "Assign a value to the range; if necessary, the value will be converted to another data type, and the cell's number format will be reset.", "description": " Aspose.Cells Cloud provides robust support for assigning a value to the range in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeValue", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "range", "in": "body", "required": true, "description": "The range in worksheet. ", "schema": { "$ref": "#/definitions/Range" }, "x-nullable": true }, { "type": "string", "name": "Value", "in": "query", "required": true, "description": "Input value.", "x-nullable": true }, { "type": "boolean", "name": "isConverted", "in": "query", "description": "True: converted to other data type if appropriate.", "default": false, "x-nullable": false }, { "type": "boolean", "name": "setStyle", "in": "query", "description": "True: set the number format to cell's style when converting to other data type.", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/moveto": { "post": { "tags": [ "Ranges" ], "summary": "Move the current range to the destination range.", "description": " Aspose.Cells Cloud provides robust support for moving the current range to the destination range in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeMoveTo", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "range", "in": "body", "required": true, "description": "range in worksheet ", "schema": { "$ref": "#/definitions/Range" }, "x-nullable": true }, { "type": "integer", "name": "destRow", "in": "query", "required": true, "description": "The start row of the dest range.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "destColumn", "in": "query", "required": true, "description": "The start column of the dest range.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/sort": { "post": { "tags": [ "Ranges" ], "summary": "Perform data sorting around a range of cells.", "description": " Aspose.Cells Cloud provides robust support for performing data sorting around a range of cells in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeSort", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "rangeSortRequest", "in": "body", "required": true, "description": "RangeSortRequest Range Sort Request ", "schema": { "$ref": "#/definitions/RangeSortRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/outlineBorder": { "post": { "tags": [ "Ranges" ], "summary": "Apply an outline border around a range of cells.", "description": " Aspose.Cells Cloud provides robust support for applying an outline border around a range of cells in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeOutlineBorder", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "rangeOperate", "in": "body", "required": true, "description": "RangeSetOutlineBorderRequest Range Set OutlineBorder Request.", "schema": { "$ref": "#/definitions/RangeSetOutlineBorderRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/columnWidth": { "post": { "tags": [ "Ranges" ], "summary": "Set the column width of the specified range.", "description": " Aspose.Cells Cloud provides robust support for setting the column width of the specified range in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCellsRangeColumnWidth", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "range", "in": "body", "required": true, "description": "Range The range object.", "schema": { "$ref": "#/definitions/Range" }, "x-nullable": true }, { "type": "number", "name": "value", "in": "query", "required": true, "description": "Sets the column width of this range.", "format": "double", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/rowHeight": { "post": { "tags": [ "Ranges" ], "summary": "Sets row height of range.", "operationId": "PostWorksheetCellsRangeRowHeight", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "range", "in": "body", "required": true, "description": "The range object.", "schema": { "$ref": "#/definitions/Range" }, "x-nullable": true }, { "type": "number", "name": "value", "in": "query", "required": true, "description": "Sets the column height of this range.", "format": "double", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges/convertToImage": { "post": { "tags": [ "Ranges" ], "operationId": "PostWorksheetCellsRangeToImage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "x-nullable": false }, { "name": "rangeConvertRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RangeConvertRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the operate is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/ranges": { "put": { "tags": [ "Ranges" ], "summary": "Insert a range of cells and shift existing cells based on the specified shift option.", "description": " Aspose.Cells Cloud provides robust support for inserting a range of cells and shift existing cells based on the specified shift option in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetCellsRange", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "The range object.", "x-nullable": true }, { "type": "string", "name": "shift", "in": "query", "required": true, "description": "Represent the shift options when deleting a range of cells(Down/Left/None/Right/Up).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Ranges" ], "summary": "Delete a range of cells and shift existing cells based on the specified shift option.", "description": " Aspose.Cells Cloud provides robust support for deleting a range of cells and shift existing cells based on the specified shift option in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetCellsRange", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "required": true, "description": "The range object.", "x-nullable": true }, { "type": "string", "name": "shift", "in": "query", "required": true, "description": "Represent the shift options when deleting a range of cells(Down/Left/None/Right/Up).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/shapes": { "get": { "tags": [ "Shapes" ], "summary": "Retrieve descriptions of shapes in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of shapes in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetShapes", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ShapesResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Shapes" ], "summary": "Add a shape in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a shape in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetShape", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "shapeDTO", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Shape" }, "x-nullable": true }, { "type": "string", "name": "DrawingType", "in": "query", "description": "Shape object type", "x-nullable": true }, { "type": "integer", "name": "upperLeftRow", "in": "query", "description": "Upper left row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "upperLeftColumn", "in": "query", "description": "Upper left column index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "top", "in": "query", "description": "Represents the vertical offset of Spinner from its left row, in unit of pixel.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "left", "in": "query", "description": "Represents the horizontal offset of Spinner from its left column, in unit of pixel.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "Represents the height of Spinner, in unit of pixel.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "Represents the width of Spinner, in unit of pixel.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Shapes" ], "summary": "Delete all shapes in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting all shapes in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetShapes", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/shapes/{shapeindex}": { "get": { "tags": [ "Shapes" ], "summary": "Retrieve description of shape in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining description of shape in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetShape", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "shapeindex", "in": "path", "required": true, "description": "shape index in worksheet shapes.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ShapeResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Shapes" ], "summary": "Delete a shape in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a shape in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetShape", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "shapeindex", "in": "path", "required": true, "description": "shape index in worksheet shapes.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Shapes" ], "summary": "Update a shape in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating a shape in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetShape", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "shapeindex", "in": "path", "required": true, "description": "shape index in worksheet shapes.", "format": "int32", "x-nullable": false }, { "name": "dto", "in": "body", "required": true, "description": "The shape description.", "schema": { "$ref": "#/definitions/Shape" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/shapes/group": { "post": { "tags": [ "Shapes" ], "summary": "Group shapes in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for grouping shapes in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetGroupShape", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "listShape", "in": "body", "required": true, "description": "Shape index array.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/shapes/{shapeindex}/ungroup": { "post": { "tags": [ "Shapes" ], "summary": "Ungroup shapes in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for ungrouping a shape in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetUngroupShape", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "shapeindex", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/sparklineGroups": { "get": { "tags": [ "SparklineGroups" ], "summary": "Retrieve descriptions of sparkline groups in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of sparkline groups in a worksheet, a process known for its intricacy.", "operationId": "GetWorksheetSparklineGroups", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/SparklineGroupsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "SparklineGroups" ], "summary": "Delete sparkline groups in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining description of a sparkline group in a worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetSparklineGroups", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "SparklineGroups" ], "summary": "Add a sparkline group in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a sparkline group in a worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetSparklineGroup", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "type", "in": "query", "required": true, "description": "Represents the sparkline types(Line/Column/Stacked).", "x-nullable": true }, { "type": "string", "name": "dataRange", "in": "query", "required": true, "description": "Specifies the data range of the sparkline group.", "x-nullable": true }, { "type": "boolean", "name": "isVertical", "in": "query", "required": true, "description": "Specifies whether to plot the sparklines from the data range by row or by column.", "x-nullable": false }, { "type": "string", "name": "locationRange", "in": "query", "required": true, "description": "Specifies where the sparklines to be placed.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/sparklineGroups/{sparklineIndex}": { "get": { "tags": [ "SparklineGroups" ], "summary": "Retrieve description of a sparkline group in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining description of a sparkline group in a worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetSparklineGroup", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "sparklineIndex", "in": "path", "required": true, "description": "The zero based index of the element.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/SparklineGroupResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "SparklineGroups" ], "summary": "Delete a sparkline group in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a sparkline group in a worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetSparklineGroup", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "sparklineIndex", "in": "path", "required": true, "description": "The zero based index of the element.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/sparklineGroups/{sparklineGroupIndex}": { "post": { "tags": [ "SparklineGroups" ], "summary": "Update a sparkline group in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating a sparkline group in a worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetSparklineGroup", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "sparklineGroupIndex", "in": "path", "required": true, "description": "The zero based index of the element.", "format": "int32", "x-nullable": false }, { "name": "sparklineGroup", "in": "body", "required": true, "description": "Spark line group description.", "schema": { "$ref": "#/definitions/SparklineGroup" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/charactercount": { "post": { "tags": [ "StatisticalCharacters" ], "operationId": "PostCharacterCount", "parameters": [ { "name": "characterCountOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CharacterCountOptions" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "type": "string" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/wordscount": { "post": { "tags": [ "StatisticalCharacters" ], "operationId": "PostWordsCount", "parameters": [ { "name": "wordsCountOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WordsCountOptions" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "type": "string" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/specifywordscount": { "post": { "tags": [ "StatisticalCharacters" ], "operationId": "PostSpecifyWordsCount", "parameters": [ { "name": "specifyWordsCountOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SpecifyWordsCountOptions" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "type": "string" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/task/runtask": { "post": { "tags": [ "Task" ], "summary": "Run tasks.", "operationId": "PostRunTask", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "object", "name": "TaskData", "in": "body", "required": true, "description": "Task Data Descrition" } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/addtext": { "post": { "tags": [ "TextProcessing" ], "summary": "Adds text content to a specified location within a document. It requires an object that defines the text to be added and the insertion location.", "description": "This method safely appends new text to specified content, supporting multiple insertion modes and format handling. \nSupports multiple insertion modes:\n - Add text to the beginning of selected cells: Prepend text to all selected cells, ensuring consistency in your data entry.This option is perfect for adding common identifiers or labels to a column of data, such as product codes, categories, or prefixes.\n - Insert characters before or after specific text: Tailor your data presentation by placing characters before or after specified text in the selected cells. This allows you to create structured and organized content with ease.\n - Append same text to the end of every selected cell: Add the same text to the end of multiple cells in one go. This simplifies data entry and ensures a uniform appearance throughout your document.\n - Insert text before or after a specified number of characters: Precision meets convenience as you add certain text after a specified number of characters from the beginning or from the end of every cell in the target range.\nTypical use cases include:", "operationId": "PostAddTextContent", "parameters": [ { "name": "addTextOptions", "in": "body", "required": true, "description": "that specifies the text content and the position where the text should be added.", "schema": { "$ref": "#/definitions/AddTextOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/trimcontent": { "post": { "tags": [ "TextProcessing" ], "summary": "The PostTrimContent API is designed to process and trim content within a specified range in a spreadsheet. This API allows users to remove extra spaces, line breaks, or other unnecessary characters from the content of selected cells. It is particularly useful for cleaning up data entries and ensuring consistency in spreadsheet formatting", "description": "Efficiency: The API efficiently trims content within the specified range, ensuring that only the designated cells are processed. This targeted approach saves time and resources by avoiding unnecessary operations on the entire worksheet.\nFlexibility: Users can define the exact range of cells to be processed, providing flexibility in handling different data sets and requirements.\nData Integrity: By removing extra spaces and line breaks, the API helps maintain data integrity and consistency, which is crucial for accurate data analysis and reporting.\nEase of Use: The API is easy to integrate into existing workflows and can be used with minimal setup, making it accessible for both developers and end-users", "operationId": "PostTrimContent", "parameters": [ { "name": "trimContentOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TrimContentOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/updatewordcase": { "post": { "tags": [ "TextProcessing" ], "summary": "Managing inconsistent text case in spreadsheets (Excel, Google Sheets, CSV) can be frustrating, especially with large datasets. The PostUpdateWordCase WEB API solves this by automating text case conversions, ensuring clean and standardized data.", "description": "This method applies case conversion to text based on the specified formatting rule (e.g., uppercase, lowercase, title case, or sentence case). It ensures consistent text formatting for use cases such as:\n- Standardizing product SKUs, invoice IDs, or codes(e.g. \"inv_123\" -> \"INV_123\").\n- Preparing user input(e.g., emails, names) for database storage or CRM imports.\n- Formatting document titles, report headers, or display text.\nNote:\n- For sentence case, ensure proper sentence boundary detection (e.g., punctuation handling).\n- For title case, consider locale-specific rules (e.g., handling minor words like \"and,\" \"the\").\n- Trimming whitespace before processing is recommended for clean output.", "operationId": "PostUpdateWordCase", "parameters": [ { "name": "wordCaseOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WordCaseOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/removecharacters": { "post": { "tags": [ "TextProcessing" ], "summary": "A comprehensive set of tools for cleaning text content within selected cells. It allows users to remove specific characters, character sets, and substrings, ensuring that the text is standardized and free from unwanted symbols or sequences.", "description": "- **Remove custom characters** will delete the characters you specify. To delete several symbols, enter each of them into the Remove custom characters field and the add-in will delete all their instances in the selected cells.\n- **Remove character sets**.\nThere are several sets of symbols you can pick from the dropdown list:\n - **Non-printing characters**: delete all non-printing characters like line breaks, the first 32 non-printing characters in the 7-bit ASCII code(values 0 through 31), and additional non-printing characters(values 127, 129, 141, 143, 144, and 157).\n - **Text characters**: remove all letters from your cells.\n - **Numeric characters**: delete all digits from the range of interest.\n - **Symbols**: remove from the cells the following symbols: mathematical, geometric, technical and currency symbols, letter-like symbols such as ?, 1, and ™.\n - **Punctuation marks**: get rid of all punctuation marks in the selected range.\n- **Remove a substring**. Delete any combination of characters, for example a word, from the selected cells.", "operationId": "PostRemoveCharacters", "parameters": [ { "name": "removeCharactersOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RemoveCharactersOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/converttext": { "post": { "tags": [ "TextProcessing" ], "summary": "Enhance Excel data through essential text conversions: convert text to numbers, replace characters and line breaks, and remove accents.", "description": "Effortlessly enhance your Excel data by performing essential text conversions. Convert numbers stored as text to the correct numerical format. Replace unwanted characters and line breaks with desired ones. Transform accented characters into their non-accented equivalents.\n- **Number Conversion**: Automatically converts text representations of numbers into their numerical equivalents, ensuring data consistency and accuracy.\n- **Character Replacement**: Provides flexibility in replacing specific characters or line breaks, allowing for customized text manipulation.\n- **Accent Removal**: Converts accented characters to their non-accented counterparts, simplifying text processing and ensuring compatibility with various systems.\n- **Usage**: This API is particularly useful for data cleaning and preparation tasks, ensuring that your Excel data is standardized and ready for further analysis or processing.It can be integrated into automated workflows to streamline data handling and reduce manual intervention.", "operationId": "PostConvertText", "parameters": [ { "name": "convertTextOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConvertTextOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/removeduplicates": { "post": { "tags": [ "TextProcessing" ], "summary": "Efficiently remove duplicate substrings from Excel cells. Select a range, specify delimiters, and apply options to eliminate repeated text segments.", "description": "- **Range Selection**: Define the range of cells to process for duplicate removal.\n- **Delimiters**: Specify delimiters to identify substrings within cells.\n- **Options**: Configure options to customize the removal process.\n- **Usage**:\n - Ideal for cleaning large datasets by removing redundant text.\n - Streamlines data preparation, ensuring cells contain unique substrings.", "operationId": "PostRemoveDuplicates", "parameters": [ { "name": "removeDuplicatesOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RemoveDuplicatesOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/extracttext": { "post": { "tags": [ "TextProcessing" ], "summary": "Effortlessly extract text and numbers from Excel cells with precise options. This API allows extraction of first/last characters, text between delimiters, and numbers from strings, with output as static values or formulas. ", "description": "Extract substrings, characters, and digits from Excel cells with options for precise text extraction. This API simplifies complex formula tasks by enabling first character extraction, text retrieval before/after/between specified characters, substring extraction from any position, last character extraction, and number extraction from alphanumeric strings. Choose output as static values or dynamic formulas.\n- **First Characters**: Extract the first character or a specified number of characters from the left of each cell.\n- **Text Before/After/Between**: Extract text relative to specified characters or substrings.\n- **Any Position**: Retrieve text from any position within a string by indicating the start position and length.\n- **Last Characters**: Extract the last character or a specified number of characters from the end of cell values.\n- **Numbers Extraction**: Extract all numbers from alphanumeric strings for quantitative analysis.", "operationId": "PostExtractText", "parameters": [ { "name": "extractTextOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExtractTextOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/splittext": { "post": { "tags": [ "TextProcessing" ], "summary": "Efficiently divides Excel cell content into columns or rows based on specified delimiters or patterns. Supports Character-based splitting, Custom string splitting, Mask and wildcard splitting for pattern-based division, Line break division, Column or row splitting, Delimiter removal or retention.", "description": "This API simplifies data extraction, making it easier to work with text and numbers in spreadsheets.\n- **First Characters**: Extract the first character or a specified number of characters from the left of each cell.\n- **Text Before/After/Between**: Extract text relative to specified characters or substrings.\n- **Any Position**: Retrieve text from any position within a string by indicating the start position and length.\n- **Last Characters**: Extract the last character or a specified number of characters from the end of cell values.\n- **Numbers Extraction**: Extract all numbers from alphanumeric strings for quantitative analysis.", "operationId": "PostSplitText", "parameters": [ { "name": "splitTextOptions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SplitTextOptions" }, "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/defaultstyle": { "get": { "tags": [ "Workbook" ], "summary": "Retrieve the description of the default style for the workbook .", "description": " Aspose.Cells Cloud provides robust support for obtaining the description of the default style for the workbook, a process known for its intricacy.", "operationId": "GetWorkbookDefaultStyle", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/StyleResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/textItems": { "get": { "tags": [ "Workbook" ], "summary": "Retrieve text items in the workbook.", "description": " Aspose.Cells Cloud provides robust support for obtaining text items in the workbook, a process known for its intricacy. ", "operationId": "GetWorkbookTextItems", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/TextItemsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/names": { "get": { "tags": [ "Workbook" ], "summary": "Retrieve named ranges in the workbook.", "description": " Aspose.Cells Cloud provides robust support for obtaining named ranges in the workbook, a process known for its intricacy. ", "operationId": "GetWorkbookNames", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/NamesResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Workbook" ], "summary": "Define a new name in the workbook.", "description": " Aspose.Cells Cloud provides robust support for defining a new name in the workbook, a process known for its intricacy. ", "operationId": "PutWorkbookName", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "newName", "in": "body", "required": true, "description": "Name", "schema": { "$ref": "#/definitions/Name" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Workbook" ], "summary": "Delete all named ranges in the workbook.", "description": " Aspose.Cells Cloud provides robust support for deleting all named ranges in the workbook, a process known for its intricacy. ", "operationId": "DeleteWorkbookNames", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/names/{nameName}": { "get": { "tags": [ "Workbook" ], "summary": "Retrieve description of a named range in the workbook.", "description": " Aspose.Cells Cloud provides robust support for obtaining description of a named range in the workbook, a process known for its intricacy. ", "operationId": "GetWorkbookName", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "nameName", "in": "path", "required": true, "description": "The name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/NameResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Workbook" ], "summary": "Update a named range in the workbook. ", "description": " Aspose.Cells Cloud provides robust support for updating a named range in the workbook, a process known for its intricacy. ", "operationId": "PostWorkbookName", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "nameName", "in": "path", "required": true, "description": "the Aspose.Cells.Name element name.", "x-nullable": false }, { "name": "newName", "in": "body", "required": true, "description": "Namenew name.", "schema": { "$ref": "#/definitions/Name" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Workbook" ], "summary": "Delete a named range in the workbook.", "description": " Aspose.Cells Cloud provides robust support for deleting a named range in the workbook, a process known for its intricacy. ", "operationId": "DeleteWorkbookName", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "nameName", "in": "path", "required": true, "description": "the Aspose.Cells.Name element name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/names/{nameName}/value": { "get": { "tags": [ "Workbook" ], "summary": "Retrieve the value of a named range in the workbook.", "description": " Aspose.Cells Cloud provides robust support for obtaining the value of a named range in the workbook, a process known for its intricacy. ", "operationId": "GetWorkbookNameValue", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "nameName", "in": "path", "required": true, "description": "the Aspose.Cells.Name element name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/merge": { "post": { "tags": [ "Workbook" ], "summary": "Merge a workbook into the existing workbook.", "description": " Aspose.Cells Cloud provides robust support for merging a workbook into the existing workbook, a process known for its intricacy. ", "operationId": "PostWorkbooksMerge", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "mergeWith", "in": "query", "required": true, "description": "The workbook to merge with.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "mergedStorageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/WorkbookResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/findText": { "post": { "tags": [ "Workbook" ], "summary": "Search for text in the workbook.", "description": " Aspose.Cells Cloud provides robust support for searching for text in the workbook, a process known for its intricacy. ", "operationId": "PostWorkbooksTextSearch", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "text", "in": "query", "required": true, "description": "Text sample.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/TextItemsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/replaceText": { "post": { "tags": [ "Workbook" ], "summary": "Replace text in the workbook.", "description": " Aspose.Cells Cloud provides robust support for replacing text in the workbook, a process known for its intricacy. ", "operationId": "PostWorkbookTextReplace", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "oldValue", "in": "query", "required": true, "description": "The old value.", "x-nullable": true }, { "type": "string", "name": "newValue", "in": "query", "required": true, "description": "The new value.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/WorkbookReplaceResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/smartmarker": { "post": { "tags": [ "Workbook" ], "summary": "Smart marker processing.", "description": " Aspose.Cells Cloud provides robust support for smart marker processing in the workbook, a process known for its intricacy. ", "operationId": "PostWorkbookGetSmartMarkerResult", "consumes": [ "multipart/form-data" ], "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "xmlFile", "in": "query", "description": "The xml file full path, if empty the data is read from request body.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "description": "The path to save result", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outStorageName", "in": "query", "description": "The storage name where the result file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/split": { "post": { "tags": [ "Workbook" ], "summary": "Split the workbook with a specific format.", "description": " Aspose.Cells Cloud provides robust support for splitting the workbook with a specific format, a process known for its intricacy. ", "operationId": "PostWorkbookSplit", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "description": "Split format.", "x-nullable": true }, { "type": "string", "name": "outFolder", "in": "query", "x-nullable": true }, { "type": "integer", "name": "from", "in": "query", "description": "Start worksheet index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "to", "in": "query", "description": "End worksheet index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "horizontalResolution", "in": "query", "description": "Image horizontal resolution.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "verticalResolution", "in": "query", "description": "Image vertical resolution.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "splitNameRule", "in": "query", "description": "rule name : sheetname newguid ", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "string", "name": "outStorageName", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/SplitResultResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/calculateformula": { "post": { "tags": [ "Workbook" ], "summary": "Calculate all formulas in the workbook.", "description": " Aspose.Cells Cloud provides robust support for calculating all formulas in the workbook, a process known for its intricacy. ", "operationId": "PostWorkbookCalculateFormula", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "options", "in": "body", "required": true, "description": "CalculationOptions Calculation Options.", "schema": { "$ref": "#/definitions/CalculationOptions" }, "x-nullable": true }, { "type": "boolean", "name": "ignoreError", "in": "query", "description": "ignore Error.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/autofitrows": { "post": { "tags": [ "Workbook" ], "summary": "Autofit rows in the workbook.", "description": " Aspose.Cells Cloud provides robust support for autofitting rows in the workbook, a process known for its intricacy. ", "operationId": "PostAutofitWorkbookRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "integer", "name": "startRow", "in": "query", "description": "Start row.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endRow", "in": "query", "description": "End row.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "onlyAuto", "in": "query", "description": "Only auto.", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "integer", "name": "firstColumn", "in": "query", "description": "First column index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "lastColumn", "in": "query", "description": "Last column index.", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/autofitcolumns": { "post": { "tags": [ "Workbook" ], "summary": "Autofit columns in the workbook.", "description": " Aspose.Cells Cloud provides robust support for autofitting columns in the workbook, a process known for its intricacy. ", "operationId": "PostAutofitWorkbookColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "integer", "name": "startColumn", "in": "query", "description": "The start column index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endColumn", "in": "query", "description": "The end column index.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/settings": { "get": { "tags": [ "Workbook" ], "summary": "Retrieve descriptions of workbook settings.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of workbook settings in the workbook, a process known for its intricacy. ", "operationId": "GetWorkbookSettings", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/WorkbookSettingsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Workbook" ], "summary": "Update setting in the workbook.", "description": " Aspose.Cells Cloud provides robust support for updating workbook settings in the workbook, a process known for its intricacy. ", "operationId": "PostWorkbookSettings", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "settings", "in": "body", "required": true, "description": "Workbook Setting description.", "schema": { "$ref": "#/definitions/WorkbookSettings" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/background": { "put": { "tags": [ "Workbook" ], "summary": "Set background in the workbook.", "description": " Aspose.Cells Cloud provides robust support for setting background in the workbook, a process known for its intricacy. ", "operationId": "PutWorkbookBackground", "consumes": [ "multipart/form-data" ], "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "picPath", "in": "query", "description": "The picture full path.", "x-nullable": true }, { "type": "string", "name": "imageAdaptOption", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "file", "name": "File", "in": "formData", "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Workbook" ], "summary": "Delete background in the workbook.", "description": " Aspose.Cells Cloud provides robust support for deleting background in the workbook, a process known for its intricacy. ", "operationId": "DeleteWorkbookBackground", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/watermarker": { "put": { "tags": [ "Workbook" ], "summary": "Set water marker in the workbook.", "description": " Aspose.Cells Cloud provides robust support for setting water marker in the workbook, a process known for its intricacy. ", "operationId": "PutWorkbookWaterMarker", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "name": "textWaterMarkerRequest", "in": "body", "required": true, "description": "Text water marker request", "schema": { "$ref": "#/definitions/TextWaterMarkerRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/pagecount": { "get": { "tags": [ "Workbook" ], "summary": "Get page count in the workbook.", "description": " Aspose.Cells Cloud provides robust support for getting page count in the workbook, a process known for its intricacy. ", "operationId": "GetPageCount", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "Returns 200 if the copy is successful.", "schema": { "type": "integer", "format": "int32" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/allstyles": { "get": { "tags": [ "Workbook" ], "summary": "Get all style in the workbook.", "operationId": "GetAllStyles", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "x-nullable": true } ], "responses": { "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve the description of worksheets from a workbook.", "description": " Aspose.Cells Cloud provides robust support for obtaining the description of worksheets from a workbook, a process known for its intricacy.", "operationId": "GetWorksheets", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/WorksheetsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Worksheets" ], "summary": "Delete matched worksheets in the workbook.", "description": " Aspose.Cells Cloud provides robust support for deleting matched worksheets in the workbook, a process known for its intricacy. ", "operationId": "DeleteWorksheets", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "name": "matchCondition", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MatchConditionRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve the worksheet in a specified format from the workbook.", "description": " Aspose.Cells Cloud provides robust support for obtaining the worksheet in a specified format from the workbook, a process known for its intricacy. ", "operationId": "GetWorksheetWithFormat", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "description": "Export format(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers).", "x-nullable": true }, { "type": "integer", "name": "verticalResolution", "in": "query", "description": "Image vertical resolution.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "horizontalResolution", "in": "query", "description": "Image horizontal resolution.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "string", "name": "area", "in": "query", "description": "Represents the range to be printed.", "x-nullable": true }, { "type": "integer", "name": "pageIndex", "in": "query", "description": "Represents the page to be printed", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "onePagePerSheet", "in": "query", "x-nullable": true }, { "type": "boolean", "name": "printHeadings", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/Stream" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Worksheets" ], "summary": "Add a new worksheet in the workbook.", "description": " Aspose.Cells Cloud provides robust support for adding a new worksheet in the workbook, a process known for its intricacy. ", "operationId": "PutAddNewWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The new sheet name.", "x-nullable": false }, { "type": "integer", "name": "position", "in": "query", "description": "The new sheet position.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "sheettype", "in": "query", "description": "Specifies the worksheet type(VB/Worksheet/Chart/BIFF4Macro/InternationalMacro/Other/Dialog).", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Worksheets" ], "summary": "Delete a worksheet in the workbook.", "description": " Aspose.Cells Cloud provides robust support for deleting a worksheet in the workbook, a process known for its intricacy. ", "operationId": "DeleteWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Worksheets" ], "summary": "Update worksheet properties in the workbook.", "description": " Aspose.Cells Cloud provides robust support for updating worksheet properties in the workbook, a process known for its intricacy. ", "operationId": "PostUpdateWorksheetProperty", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "sheet", "in": "body", "required": true, "description": "The worksheet description.", "schema": { "$ref": "#/definitions/Worksheet" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/visible": { "put": { "tags": [ "Worksheets" ], "summary": "Change worksheet visibility in the workbook.", "description": " Aspose.Cells Cloud provides robust support for changing worksheet visibility in the workbook, a process known for its intricacy. ", "operationId": "PutChangeVisibilityWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "Worksheet name.", "x-nullable": false }, { "type": "boolean", "name": "isVisible", "in": "query", "required": true, "description": "New worksheet visibility value.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/active": { "put": { "tags": [ "Worksheets" ], "summary": "Set active worksheet index in the workbook.", "description": " Aspose.Cells Cloud provides robust support for setting active worksheet index in the workbook, a process known for its intricacy. ", "operationId": "PutActiveWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/insert": { "put": { "tags": [ "Worksheets" ], "summary": "Insert a new worksheet in the workbook.", "description": " Aspose.Cells Cloud provides robust support for inserting a new worksheet in the workbook, a process known for its intricacy. ", "operationId": "PutInsertNewWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "query", "required": true, "description": "The worksheet name.", "x-nullable": true }, { "type": "integer", "name": "index", "in": "query", "required": true, "format": "int32", "x-nullable": false }, { "type": "string", "name": "sheettype", "in": "query", "required": true, "description": "Specifies the worksheet type(VB/Worksheet/Chart/BIFF4Macro/InternationalMacro/Other/Dialog).", "x-nullable": true }, { "type": "string", "name": "newsheetname", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/position": { "post": { "tags": [ "Worksheets" ], "summary": "Move worksheet in the workbook.", "description": " Aspose.Cells Cloud provides robust support for moving worksheet in the workbook, a process known for its intricacy. ", "operationId": "PostMoveWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "moving", "in": "body", "required": true, "description": "WorksheetMovingRequest with moving parameters.", "schema": { "$ref": "#/definitions/WorksheetMovingRequest" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/protection": { "put": { "tags": [ "Worksheets" ], "summary": "Protect worksheet.", "description": " Aspose.Cells Cloud provides robust support for protecting worksheet in the workbook, a process known for its intricacy. ", "operationId": "PutProtectWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "protectParameter", "in": "body", "required": true, "description": "ProtectSheetParameter with protection settings.", "schema": { "$ref": "#/definitions/ProtectSheetParameter" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Worksheets" ], "summary": "Unprotect worksheet.", "description": " Aspose.Cells Cloud provides robust support for unprotecting worksheet in the workbook, a process known for its intricacy. ", "operationId": "DeleteUnprotectWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "name": "protectParameter", "in": "body", "required": true, "description": "WorksheetResponse with protection settings. Only password is used here.", "schema": { "$ref": "#/definitions/ProtectSheetParameter" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/textItems": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve text items in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining text items in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetTextItems", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "Workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/TextItemsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/comments": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve the description of comments in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining the description of comments in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetComments", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CommentsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Worksheets" ], "summary": "Delete all comments in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting all comments in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetComments", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/comments/{cellName}": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve the description of comment in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining the description of comment in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetComment", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CommentResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Worksheets" ], "summary": "Add cell comment in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding cell comment in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetComment", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "name": "comment", "in": "body", "required": true, "description": "Comment object.", "schema": { "$ref": "#/definitions/Comment" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CommentResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Worksheets" ], "summary": "Update cell comment in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating cell comment in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetComment", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "name": "comment", "in": "body", "required": true, "description": "Comment object.", "schema": { "$ref": "#/definitions/Comment" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Worksheets" ], "summary": "Delete cell comment in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting cell comment in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetComment", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellName", "in": "path", "required": true, "description": "The cell name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/mergedCells": { "get": { "tags": [ "Worksheets" ], "summary": "Get worksheet merged cells.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of merged cells in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetMergedCells", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The workseet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/MergedCellsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/mergedCells/{mergedCellIndex}": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve description of a merged cell by its index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of merged cells in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetMergedCell", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "Worksheet name.", "x-nullable": false }, { "type": "integer", "name": "mergedCellIndex", "in": "path", "required": true, "description": "Merged cell index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/MergedCellResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/formulaResult": { "get": { "tags": [ "Worksheets" ], "summary": "Calculate formula in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for calculating formula in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetCalculateFormula", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "formula", "in": "query", "required": true, "description": "The formula.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/SingleValueResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/calculateformula": { "post": { "tags": [ "Worksheets" ], "summary": "Calculate formula in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for calculating formula in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetCalculateFormula", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "Worksheet name.", "x-nullable": false }, { "type": "string", "name": "formula", "in": "query", "required": true, "description": "The formula.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/SingleValueResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/findText": { "post": { "tags": [ "Worksheets" ], "summary": "Search for text in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for searching for text in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetTextSearch", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "text", "in": "query", "required": true, "description": "Text to search.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/replaceText": { "post": { "tags": [ "Worksheets" ], "summary": "Replace old text with new text in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for replacing old text with new text in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetTextReplace", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "Worksheet name.", "x-nullable": false }, { "type": "string", "name": "oldValue", "in": "query", "required": true, "description": "The old text to replace.", "x-nullable": true }, { "type": "string", "name": "newValue", "in": "query", "required": true, "description": "The new text to replace by.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/WorksheetReplaceResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/sort": { "post": { "tags": [ "Worksheets" ], "summary": "Sort a range in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for sorting a range in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetRangeSort", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "cellArea", "in": "query", "required": true, "description": "The area needed to sort.", "x-nullable": true }, { "name": "dataSorter", "in": "body", "required": true, "description": "DataSorter with sorting settings.", "schema": { "$ref": "#/definitions/DataSorter" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autofitrow": { "post": { "tags": [ "Worksheets" ], "summary": "Autofit a row in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for autofitting a row in the worksheet, a process known for its intricacy. ", "operationId": "PostAutofitWorksheetRow", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "rowIndex", "in": "query", "required": true, "description": "The row index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "firstColumn", "in": "query", "description": "The first column index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "lastColumn", "in": "query", "description": "The last column index.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "integer", "name": "rowCount", "in": "query", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autofitrows": { "post": { "tags": [ "Worksheets" ], "summary": "Autofit rows in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for autofitting rows in the worksheet, a process known for its intricacy. ", "operationId": "PostAutofitWorksheetRows", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startRow", "in": "query", "description": "The start row index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endRow", "in": "query", "description": "The end row index.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "onlyAuto", "in": "query", "description": "Autofits all rows in this worksheet.", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/autofitcolumns": { "post": { "tags": [ "Worksheets" ], "summary": "Autofit columns in the worksheet. \n ", "description": " Aspose.Cells Cloud provides robust support for autofitting columns in the worksheet, a process known for its intricacy. ", "operationId": "PostAutofitWorksheetColumns", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "startColumn", "in": "query", "description": "The start column index.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endColumn", "in": "query", "description": "The end column index.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "onlyAuto", "in": "query", "default": false, "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/background": { "put": { "tags": [ "Worksheets" ], "summary": "Set background image in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting background image in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetBackground", "consumes": [ "multipart/form-data" ], "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "picPath", "in": "query", "description": "picture full filename.", "x-nullable": true }, { "type": "string", "name": "imageAdaptOption", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true }, { "type": "file", "name": "File", "in": "formData", "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Worksheets" ], "summary": "Delete background image in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting background image in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetBackground", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/freezepanes": { "put": { "tags": [ "Worksheets" ], "summary": "Set freeze panes in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for setting freeze panes in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetFreezePanes", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "row", "in": "query", "required": true, "description": "Row index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "column", "in": "query", "required": true, "description": "Column index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "freezedRows", "in": "query", "required": true, "description": "Number of visible rows in top pane, no more than row index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "freezedColumns", "in": "query", "required": true, "description": "Number of visible columns in left pane, no more than column index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Worksheets" ], "summary": "Unfreeze panes in worksheet.", "description": " Aspose.Cells Cloud provides robust support for unfreezing panes in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetFreezePanes", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "row", "in": "query", "required": true, "description": "Row index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "column", "in": "query", "required": true, "description": "Column index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "freezedRows", "in": "query", "required": true, "description": "Number of visible rows in top pane, no more than row index.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "freezedColumns", "in": "query", "required": true, "description": "Number of visible columns in left pane, no more than column index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/copy": { "post": { "tags": [ "Worksheets" ], "summary": "Copy contents and formats from another worksheet.", "description": " Aspose.Cells Cloud provides robust support for copying contents and formats from another worksheet, a process known for its intricacy. ", "operationId": "PostCopyWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "sourceSheet", "in": "query", "required": true, "description": "Source worksheet.", "x-nullable": true }, { "name": "options", "in": "body", "required": true, "description": "Represents the copy options.", "schema": { "$ref": "#/definitions/CopyOptions" }, "x-nullable": true }, { "type": "string", "name": "sourceWorkbook", "in": "query", "description": "source Workbook.", "x-nullable": true }, { "type": "string", "name": "sourceFolder", "in": "query", "description": "Original workbook folder.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/rename": { "post": { "tags": [ "Worksheets" ], "summary": "Rename worksheet in the workbook.", "description": " Aspose.Cells Cloud provides robust support for renaming worksheet in the workbook, a process known for its intricacy. ", "operationId": "PostRenameWorksheet", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "newname", "in": "query", "required": true, "description": "New worksheet name.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/ranges": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve descriptions of ranges in the worksheets.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of ranges in the worksheets, a process known for its intricacy. ", "operationId": "GetNamedRanges", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/RangesResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/ranges/{namerange}/value": { "get": { "tags": [ "Worksheets" ], "summary": "Retrieve values in range.", "description": " Aspose.Cells Cloud provides robust support for obtaining values in range, a process known for its intricacy. ", "operationId": "GetNamedRangeValue", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "namerange", "in": "path", "required": true, "description": "Range name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/RangeValueResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/zoom": { "post": { "tags": [ "Worksheets" ], "summary": "Update the scaling percentage in the worksheet. It should be between 10 and 400.", "description": " Aspose.Cells Cloud provides robust support for updating the scaling percentage in the worksheet, a process known for its intricacy. ", "operationId": "PostUpdateWorksheetZoom", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "value", "in": "query", "required": true, "description": "Represents the scaling factor in percentage. It should be between 10 and 400.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/pagecount": { "get": { "tags": [ "Worksheets" ], "summary": "Get page count in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for getting page count in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetPageCount", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The file name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "Returns 200 if the copy is successful.", "schema": { "type": "integer", "format": "int32" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/validations": { "get": { "tags": [ "WorksheetValidations" ], "summary": "Retrieve descriptions of validations in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining descriptions of validations in the worksheet, a process known for its intricacy.", "operationId": "GetWorksheetValidations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ValidationsResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "WorksheetValidations" ], "summary": "Add a validation at index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for adding a validation at index in the worksheet, a process known for its intricacy. ", "operationId": "PutWorksheetValidation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "range", "in": "query", "description": "Specified cells area", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "WorksheetValidations" ], "summary": "Delete all validations in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting all validations in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetValidations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/{name}/worksheets/{sheetName}/validations/{validationIndex}": { "get": { "tags": [ "WorksheetValidations" ], "summary": "Retrieve a validation by its index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for obtaining a validation by its index in the worksheet, a process known for its intricacy. ", "operationId": "GetWorksheetValidation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "validationIndex", "in": "path", "required": true, "description": "The validation index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/ValidationResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "WorksheetValidations" ], "summary": "Update a validation by index in the worksheet.", "description": " Aspose.Cells Cloud provides robust support for updating a validation at index in the worksheet, a process known for its intricacy. ", "operationId": "PostWorksheetValidation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "validationIndex", "in": "path", "required": true, "description": "The validation index.", "format": "int32", "x-nullable": false }, { "name": "validation", "in": "body", "required": true, "description": "Validation description.", "schema": { "$ref": "#/definitions/Validation" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "WorksheetValidations" ], "summary": "Delete a validation by index in worksheet.", "description": " Aspose.Cells Cloud provides robust support for deleting a validation at index in the worksheet, a process known for its intricacy. ", "operationId": "DeleteWorksheetValidation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The workbook name.", "x-nullable": false }, { "type": "string", "name": "sheetName", "in": "path", "required": true, "description": "The worksheet name.", "x-nullable": false }, { "type": "integer", "name": "validationIndex", "in": "path", "required": true, "description": "The validation index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The folder where the file is situated.", "x-nullable": true }, { "type": "string", "name": "storageName", "in": "query", "description": "The storage name where the file is situated.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns 200 if the copy is successful.", "schema": { "$ref": "#/definitions/CellsCloudResponse" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/file/{path}": { "get": { "tags": [ "File" ], "summary": "Download file", "operationId": "DownloadFile", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File path e.g. '/folder/file.ext'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to download", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "The raw data of the file.", "schema": { "type": "file" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "File for given path not found." } }, "security": [ { "JWT": [] } ], "x-binary-result": true }, "put": { "tags": [ "File" ], "summary": "Upload file", "operationId": "UploadFile", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext\n If the content is multipart and path does not contains the file name it tries to get them from filename parameter\n from Content-Disposition header.\n ", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "file", "name": "File", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "Empty error list if the upload is successful.", "schema": { "$ref": "#/definitions/FilesUploadResult" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "File" ], "summary": "Delete file", "operationId": "DeleteFile", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File path e.g. '/folder/file.ext'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to delete", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the delete is successful." }, "401": { "description": "Authorization token is invalid or expired" } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/file/copy/{srcPath}": { "put": { "tags": [ "File" ], "summary": "Copy file", "operationId": "CopyFile", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Source file path e.g. '/folder/file.ext'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination file path", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to copy", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the copy is successful." }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/file/move/{srcPath}": { "put": { "tags": [ "File" ], "summary": "Move file", "operationId": "MoveFile", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Source file path e.g. '/src.ext'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination file path e.g. '/dest.ext'", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to move", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the move is successful." }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "File for given path not found." } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/folder/{path}": { "get": { "tags": [ "Folder" ], "summary": "Get all files and folders within a folder", "operationId": "GetFilesList", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Folder path e.g. '/folder'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns all files and folders contained by the folder.", "schema": { "$ref": "#/definitions/FilesList" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Folder" ], "summary": "Create the folder", "operationId": "CreateFolder", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Folder path to create e.g. 'folder_1/folder_2/'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the create is successful." }, "401": { "description": "Authorization token is invalid or expired." }, "400": { "description": "Storage not found or it is not associated with the application." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Folder" ], "summary": "Delete folder", "operationId": "DeleteFolder", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Folder path e.g. '/folder'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "boolean", "name": "recursive", "in": "query", "description": "Enable to delete folders, subfolders and files", "default": false, "x-nullable": false } ], "responses": { "200": { "description": "Returns 200 if the delete is successful." }, "401": { "description": "Authorization token is invalid or expired" } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/folder/copy/{srcPath}": { "put": { "tags": [ "Folder" ], "summary": "Copy folder", "operationId": "CopyFolder", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Source folder path e.g. '/src'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination folder path e.g. '/dst'", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the copy is successful." }, "401": { "description": "Authorization token is invalid or expired" } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/folder/move/{srcPath}": { "put": { "tags": [ "Folder" ], "summary": "Move folder", "operationId": "MoveFolder", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Folder path to move e.g. '/folder'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination folder path to move to e.g '/dst'", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the move is successful." }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/{storageName}/exist": { "get": { "tags": [ "Storage" ], "summary": "Check if storage exists", "operationId": "StorageExists", "parameters": [ { "type": "string", "name": "storageName", "in": "path", "required": true, "description": "Storage name", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Storage exist result.", "schema": { "$ref": "#/definitions/StorageExist" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/exist/{path}": { "get": { "tags": [ "Storage" ], "summary": "Check if file or folder exists", "operationId": "ObjectExists", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File or folder path e.g. '/file.ext' or '/folder'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Object exist result.", "schema": { "$ref": "#/definitions/ObjectExist" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/disc": { "get": { "tags": [ "Storage" ], "summary": "Get disc usage", "operationId": "GetDiscUsage", "parameters": [ { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Disc usage.", "schema": { "$ref": "#/definitions/DiscUsage" } }, "400": { "description": "Storage not found or it is not associated with an application." }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/cells/storage/version/{path}": { "get": { "tags": [ "Storage" ], "summary": "Get file versions", "operationId": "GetFileVersions", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File path e.g. '/file.ext'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "File versions.", "schema": { "$ref": "#/definitions/FileVersions" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } } }, "definitions": { "CellsCloudResponse": { "type": "object", "discriminator": "Type", "description": " Represents the CellsCloud Response.\n ", "additionalProperties": false, "required": [ "Code" ], "properties": { "Code": { "description": "The property \"Code\" allows for accessing and modifying the HTTP status code of the response.", "enum": [ "Continue", "SwitchingProtocols", "Processing", "EarlyHints", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "UnavailableForLegalReasons", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "allOf": [ {} ] }, "Status": { "type": "string" } } }, "AnalyzeExcelRequest": { "type": "object", "description": "Can you please provide the features that you would like me to summarize for the class?", "additionalProperties": false, "required": [ "NeedThumbnail", "BuildSuggestoinSheet" ], "properties": { "Files": { "type": "array", "description": "The class has a property called \"Files\" that is a list of FileInfo objects with a default value of an empty list.", "items": { "$ref": "#/definitions/FileInfo" } }, "NeedThumbnail": { "type": "boolean" }, "BuildSuggestoinSheet": { "type": "boolean" } } }, "FileInfo": { "type": "object", "description": "Represents file information.", "additionalProperties": false, "required": [ "FileSize" ], "properties": { "Filename": { "type": "string", "description": "Represents filename. " }, "FileSize": { "type": "integer", "description": "Represents file size.", "format": "int64" }, "FileContent": { "type": "string", "description": "Represents file content, byte to base64 string." } } }, "AutoFilterResponse": { "type": "object", "description": " Represents the AutoFilter Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the AutoFilter Response.\n ", "additionalProperties": false, "properties": { "AutoFilter": { "description": "A property named \"AutoFilter\" with a type of \"AutoFilter\" that can be read from and written to.", "allOf": [ {} ], "$ref": "#/definitions/AutoFilter" } } } ] }, "AutoFilter": { "type": "object", "description": "Represents autofiltering for the specified worksheet.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents autofiltering for the specified worksheet.", "additionalProperties": false, "properties": { "FilterColumns": { "type": "array", "description": "Gets the collection of the filter columns.\n ", "items": { "$ref": "#/definitions/FilterColumn" } }, "Range": { "type": "string", "description": "Represents the range to which the specified AutoFilter applies.\n " }, "Sorter": { "description": "Gets the data sorter.\n ", "allOf": [ {} ], "$ref": "#/definitions/DataSorter" }, "ShowFilterButton": { "type": "boolean", "description": "Indicates whether the AutoFilter button for this column is visible.\n " } } } ] }, "FilterColumn": { "type": "object", "description": " Represents a filter for a single column. The Filter object is a member of the Filters collection\n ", "additionalProperties": false, "required": [ "FieldIndex" ], "properties": { "FieldIndex": { "type": "integer", "description": "Gets and sets the column offset in the range.\n ", "format": "int32" }, "FilterType": { "type": "string", "description": "Gets and sets the type fo filtering data.\n " }, "MultipleFilters": { "description": "This class contains a property named \"MultipleFilters\" of type \"MultipleFilters\" that can be both read and written.", "allOf": [ {} ], "$ref": "#/definitions/MultipleFilters" }, "ColorFilter": { "$ref": "#/definitions/ColorFilter" }, "CustomFilters": { "type": "array", "items": { "$ref": "#/definitions/CustomFilter" } }, "DynamicFilter": { "$ref": "#/definitions/DynamicFilter" }, "IconFilter": { "$ref": "#/definitions/IconFilter" }, "Top10Filter": { "$ref": "#/definitions/Top10Filter" }, "Visibledropdown": { "type": "string", "description": "Indicates whether the AutoFilter button for this column is visible.\n " } } }, "MultipleFilters": { "type": "object", "description": " Represents the multiple filter collection.\n ", "additionalProperties": false, "properties": { "MatchBlank": { "type": "boolean", "description": "A nullable boolean property that determines if a blank space should be matched." }, "MultipleFilterList": { "type": "array", "items": { "$ref": "#/definitions/MultipleFilter" } } } }, "MultipleFilter": { "type": "object", "description": "Class Summary: The features include real-time collaboration, file sharing, scheduling, task tracking, and discussion forums to enhance communication and productivity.", "x-abstract": true, "additionalProperties": false }, "ColorFilter": { "type": "object", "description": "Color filter.", "additionalProperties": false, "properties": { "FilterByFillColor": { "type": "boolean", "description": "Whether filter by the cell's fill color.\n " }, "Pattern": { "type": "string", "description": "A property \"Pattern\" of type string with a getter and setter is defined." }, "Color": { "$ref": "#/definitions/CellsColor" }, "ForegroundColorColor": { "$ref": "#/definitions/CellsColor" }, "BackgroundColor": { "$ref": "#/definitions/CellsColor" } } }, "CellsColor": { "type": "object", "description": " Represents all types of color.\n ", "additionalProperties": false, "properties": { "Color": { "description": "Gets and sets the RGB color.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "ColorIndex": { "type": "integer", "description": "Gets and sets the color index in the color palette. Only applies of indexed color.\n ", "format": "int32" }, "IsShapeColor": { "type": "boolean", "description": "Gets and set the color which should apply to cell or shape.\n " }, "tint": { "type": "number", "description": "Set the tint of the shape color", "format": "double" }, "Argb": { "type": "integer", "description": "Gets and sets the color from a 32-bit ARGB value.\n ", "format": "int32" }, "ThemeColor": { "description": "Gets the theme color. Only applies for theme color type.\n ", "allOf": [ {} ], "$ref": "#/definitions/ThemeColor" }, "Type": { "type": "string", "description": "The color type.\n " }, "Transparency": { "type": "number", "description": "Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).\n ", "format": "double" } } }, "Color": { "type": "object", "description": "Color.", "additionalProperties": false, "required": [ "A", "R", "G", "B" ], "properties": { "A": { "type": "integer", "description": "Gets the alpha component value of this System.Drawing.Color structure.\n ", "format": "byte" }, "R": { "type": "integer", "description": "Gets the red component value of this System.Drawing.Color structure.\n ", "format": "byte" }, "G": { "type": "integer", "description": "Gets the green component value of this System.Drawing.Color structure.", "format": "byte" }, "B": { "type": "integer", "description": "Gets the blue component value of this System.Drawing.Color structure.\n ", "format": "byte" } } }, "ThemeColor": { "type": "object", "description": " Represents a theme color.\n ", "additionalProperties": false, "properties": { "ColorType": { "type": "string", "description": "Gets and sets the theme type.\n " }, "Tint": { "type": "number", "description": "Gets and sets the tint value.\n ", "format": "double" } } }, "CustomFilter": { "type": "object", "description": " Represents the custom filter.\n ", "additionalProperties": false, "properties": { "Criteria": { "description": "Gets and sets the criteria.\n " }, "FilterOperatorType": { "type": "string", "description": "Gets and sets the filter operator type.\n " } } }, "DynamicFilter": { "type": "object", "description": " Represents the dynamic filter.\n ", "additionalProperties": false, "properties": { "DynamicFilterType": { "type": "string", "description": "Gets and sets the dynamic filter type.\n " }, "MaxValue": { "description": "Gets and sets the dynamic filter max value.\n " }, "Value": { "description": "Gets and sets the dynamic filter value.\n " } } }, "IconFilter": { "type": "object", "description": " Represents icon filter.\n ", "additionalProperties": false, "required": [ "IconId" ], "properties": { "IconId": { "type": "integer", "description": "Gets and sets Zero-based index of an icon in an icon set.\n ", "format": "int32" }, "IconSetType": { "type": "string", "description": "Gets and sets which icon set is used in the filter criteria.\n " } } }, "Top10Filter": { "type": "object", "description": " Represents the top 10 filter.\n ", "additionalProperties": false, "required": [ "FieldIndex", "IsPercent", "IsTop", "Items" ], "properties": { "FieldIndex": { "type": "integer", "description": "An integer property named FieldIndex that can be accessed and modified.\n ", "format": "int32" }, "Criteria": { "type": "string", "description": " " }, "IsPercent": { "type": "boolean", "description": "Indicates whether the items is percent.\n " }, "IsTop": { "type": "boolean", "description": "Indicates whether it's top filter.\n " }, "Items": { "type": "integer", "description": "Gets and sets the items of the filter.\n ", "format": "int32" } } }, "DataSorter": { "type": "object", "description": "Summary description for DataSorter.", "additionalProperties": false, "properties": { "CaseSensitive": { "type": "boolean", "description": "Gets and sets whether case sensitive when comparing string.\n " }, "HasHeaders": { "type": "boolean", "description": "Represents whether the range has headers.\n " }, "KeyList": { "type": "array", "description": "Gets the key list of data sorter.\n ", "items": { "$ref": "#/definitions/SortKey" } }, "SortLeftToRight": { "type": "boolean", "description": "True means that sorting orientation is from left to right.\n False means that sorting orientation is from top to bottom.\n The default value is false.\n " }, "SortAsNumber": { "type": "boolean", "description": "Indicates whether sorting anything that looks like a number.\n " }, "Keys": { "type": "array", "description": "Gets the key list of data sorter.\n ", "items": { "$ref": "#/definitions/DataSorterKey" } } } }, "SortKey": { "type": "object", "description": "Represents sort key.", "additionalProperties": false, "required": [ "Key", "Index" ], "properties": { "Key": { "type": "integer", "description": "Represents the key of sorting.", "format": "int32" }, "SortOrder": { "type": "string", "description": "Represents the order of sorting." }, "CustomList": { "type": "array", "description": "This class includes a property named CustomList that is an array of strings with both getter and setter methods.", "items": { "type": "string" } }, "Order": { "type": "string", "description": "Indicates the order of sorting." }, "Index": { "type": "integer", "description": "Gets the sorted column index(absolute position, column A is 0, B is 1, ...).", "format": "int32" }, "Type": { "type": "string", "description": "Represents the type of sorting." } } }, "DataSorterKey": { "type": "object", "description": "Represents the key of the data sorter.\n ", "additionalProperties": false, "properties": { "Order": { "type": "string", "description": "Indicates the order of sorting.\n " }, "Index": { "type": "integer", "description": "Gets the sorted column index(absolute position, column A is 0, B is 1, ...).\n ", "format": "int32" }, "Type": { "type": "string", "description": "Represents the type of sorting.\n " }, "IconSetType": { "type": "string", "description": "Represents the icon set type.\n " }, "IconId": { "type": "integer", "description": "Represents the id of the icon set type.\n ", "format": "int32" }, "Color": { "description": "Gets the sorted color.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" } } }, "LinkElement": { "type": "object", "discriminator": "Type", "description": "Class summary: The features include automatic emergency braking, lane keeping assist, adaptive cruise control, blind spot monitoring, and rear cross-traffic alert.", "additionalProperties": false, "properties": { "link": { "description": "The class has a property named \"link\" of type Link, which has a public get and set accessors.", "allOf": [ {} ], "$ref": "#/definitions/Link" } } }, "Link": { "type": "object", "description": "I'm glad to help! Please provide me with the features you would like me to summarize.", "additionalProperties": false, "properties": { "Href": { "type": "string", "description": "Has a property named Href with the attribute ElementName set to \"href\"." }, "Rel": { "type": "string" }, "Title": { "type": "string" }, "Type": { "type": "string" } } }, "ColorFilterRequest": { "type": "object", "description": "Indicates color filter request", "additionalProperties": false, "properties": { "Pattern": { "type": "string", "description": "Gets or sets the fill pattern type" }, "ForegroundColor": { "description": "Foreground color", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "BackgroundColor": { "description": "Background color", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" } } }, "Stream": { "allOf": [ { "$ref": "#/definitions/MarshalByRefObject" }, { "type": "object", "x-abstract": true, "additionalProperties": false, "required": [ "CanTimeout", "ReadTimeout", "WriteTimeout" ], "properties": { "CanTimeout": { "type": "boolean" }, "ReadTimeout": { "type": "integer", "format": "int32" }, "WriteTimeout": { "type": "integer", "format": "int32" } } } ] }, "MarshalByRefObject": { "type": "object", "discriminator": "Type", "x-abstract": true, "additionalProperties": false }, "BatchConvertRequest": { "type": "object", "description": "Indicates batch convert file request", "additionalProperties": false, "properties": { "SourceFolder": { "type": "string", "description": "The directory stores files that need to format conversion." }, "SourceStorage": { "type": "string", "description": "Aspose Cloud storage name." }, "MatchCondition": { "description": "Indicates the match condition that needs to be processed for the file name.", "allOf": [ {} ], "$ref": "#/definitions/MatchConditionRequest" }, "Format": { "type": "string", "description": "Conversion format." }, "OutFolder": { "type": "string", "description": "The directory that stores files whose format conversion was successful." }, "OutStorage": { "type": "string", "description": "Aspose Cloud storage name." }, "Region": { "type": "string", "description": "The regional settings for workbook." }, "PageWideFitOnPerSheet": { "type": "boolean", "description": "A nullable Boolean property that determines whether the content should be fit to the entire page width on each sheet." }, "PageTallFitOnPerSheet": { "type": "boolean" }, "SaveOptions": { "description": "Indicates save options.", "allOf": [ {} ], "$ref": "#/definitions/SaveOptions" } } }, "MatchConditionRequest": { "type": "object", "description": "Indicates the match condition that needs to be processed for the file name.", "additionalProperties": false, "properties": { "RegexPattern": { "type": "string", "description": "Regex Pattern." }, "FullMatchConditions": { "type": "array", "description": "Name list.", "items": { "type": "string" } } } }, "SaveOptions": { "type": "object", "description": "Represents all save options", "additionalProperties": false, "properties": { "SaveFormat": { "type": "string", "description": "Save format name" }, "CachedFileFolder": { "type": "string", "description": "The cached file folder is used to store some large data." }, "ClearData": { "type": "boolean", "description": "Make the workbook empty after saving the file." }, "CreateDirectory": { "type": "boolean", "description": "If true and the directory does not exist, the directory will be automatically created before saving the file.\n " }, "EnableHTTPCompression": { "type": "boolean", "description": "whether http compression is to be used." }, "RefreshChartCache": { "type": "boolean", "description": "Indicates whether refreshing chart cache data" }, "SortNames": { "type": "boolean", "description": "Indicates whether sorting defined names before saving file." }, "ValidateMergedAreas": { "type": "boolean", "description": "Indicates whether validate merged areas before saving the file.\nThe default value is false.\n " }, "MergeAreas": { "type": "boolean" }, "SortExternalNames": { "type": "boolean" }, "CheckExcelRestriction": { "type": "boolean" }, "UpdateSmartArt": { "type": "boolean" }, "EncryptDocumentProperties": { "type": "boolean" } } }, "BatchProtectRequest": { "type": "object", "description": "Indicates batch protect file request", "additionalProperties": false, "properties": { "SourceFolder": { "type": "string", "description": "The directory stores files that need to format conversion.\n " }, "SourceStorage": { "type": "string", "description": "Aspose Cloud storage name" }, "MatchCondition": { "description": "Indicates the match condition that needs to be processed for the file name.", "allOf": [ {} ], "$ref": "#/definitions/MatchConditionRequest" }, "ProtectionType": { "type": "string", "description": "This property defines the protection type of an object." }, "Password": { "type": "string", "description": " " }, "OutFolder": { "type": "string", "description": "The directory that stores files whose format conversion was successful." }, "OutStorage": { "type": "string", "description": "Aspose Cloud storage name." } } }, "BatchLockRequest": { "type": "object", "description": "Indicates batch lock file request", "additionalProperties": false, "properties": { "SourceFolder": { "type": "string", "description": "The directory stores files that need to format conversion.\n " }, "SourceStorage": { "type": "string", "description": "Aspose Cloud storage name" }, "MatchCondition": { "description": "Indicates the match condition that needs to be processed for the file name.", "allOf": [ {} ], "$ref": "#/definitions/MatchConditionRequest" }, "Password": { "type": "string", "description": "Lock file with password" }, "OutFolder": { "type": "string", "description": "The directory that stores files whose format conversion was successful.\n " }, "OutStorage": { "type": "string", "description": "Aspose Cloud storage name" } } }, "BatchSplitRequest": { "type": "object", "description": "Class summary: Identifying key features of a statistical dataset and methods for data analysis.", "additionalProperties": false, "properties": { "SourceFolder": { "type": "string", "description": "The directory stores files that need to format conversion.\n " }, "SourceStorage": { "type": "string", "description": "Aspose Cloud storage name" }, "MatchCondition": { "description": "Indicates the match condition that needs to be processed for the file name.", "allOf": [ {} ], "$ref": "#/definitions/MatchConditionRequest" }, "Format": { "type": "string", "description": "Output file format" }, "FromIndex": { "type": "integer", "description": "From worksheet index of workbook.", "format": "int32" }, "ToIndex": { "type": "integer", "description": "To worksheet index of workbook.", "format": "int32" }, "OutFolder": { "type": "string", "description": "The directory that stores files whose format conversion was successful." }, "OutStorage": { "type": "string", "description": "Aspose Cloud storage name." }, "Region": { "type": "string", "description": "The regional settings for workbook." }, "SaveOptions": { "description": "Indicates save options.", "allOf": [ {} ], "$ref": "#/definitions/SaveOptions" } } }, "Style": { "type": "object", "description": " Represents display style of excel document,such as font,color,alignment,border,etc. The Style object contains all style attributes (font, number format, alignment, and so on) as properties.\n ", "additionalProperties": false, "properties": { "Font": { "description": "Gets a object.\n ", "allOf": [ {} ], "$ref": "#/definitions/Font" }, "Name": { "type": "string", "description": "Gets or sets the name of the style.\n " }, "CultureCustom": { "type": "string", "description": "Gets and sets the culture-dependent pattern string for number format.\n If no number format has been set for this object, null will be returned.\n If number format is builtin, the pattern string corresponding to the builtin number will be returned.\n " }, "Custom": { "type": "string", "description": "Represents the custom number format string of this style object.\n If the custom number format is not set(For example, the number format is builtin), \"\" will be returned.\n " }, "BackgroundColor": { "description": "Gets or sets a style's background color.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "ForegroundColor": { "description": "Gets or sets a style's foreground color.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "IsFormulaHidden": { "type": "boolean", "description": "Represents if the formula will be hidden when the worksheet is protected.\n " }, "IsDateTime": { "type": "boolean", "description": "Indicates whether the number format is a date format.\n " }, "IsTextWrapped": { "type": "boolean", "description": "Gets or sets a value indicating whether the text within a cell is wrapped.\n " }, "IsGradient": { "type": "boolean", "description": "Indicates whether the cell shading is a gradient pattern.\n " }, "IsLocked": { "type": "boolean", "description": "Gets or sets a value indicating whether a cell can be modified or not.\n " }, "IsPercent": { "type": "boolean", "description": "Indicates whether the number format is a percent format.\n " }, "ShrinkToFit": { "type": "boolean", "description": "Represents if text automatically shrinks to fit in the available column width.\n " }, "IndentLevel": { "type": "integer", "description": "Represents the indent level for the cell or range. Can only be an integer from 0 to 250.\n ", "format": "int32" }, "Number": { "type": "integer", "description": "Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.\n ", "format": "int32" }, "RotationAngle": { "type": "integer", "description": "Represents text rotation angle.\n ", "format": "int32" }, "Pattern": { "type": "string", "description": "Gets or sets the cell background pattern type.\n " }, "TextDirection": { "type": "string", "description": "Represents text reading order.\n " }, "VerticalAlignment": { "type": "string", "description": "Gets or sets the vertical alignment type of the text in a cell.\n " }, "HorizontalAlignment": { "type": "string", "description": "Gets or sets the horizontal alignment type of the text in a cell.\n " }, "BorderCollection": { "type": "array", "description": "A public property named `BorderCollection` that is a list of `Border` objects.", "items": { "$ref": "#/definitions/Border" } }, "BackgroundThemeColor": { "description": "Gets and sets the background theme color.\n ", "allOf": [ {} ], "$ref": "#/definitions/ThemeColor" }, "ForegroundThemeColor": { "description": "Gets and sets the foreground theme color.\n ", "allOf": [ {} ], "$ref": "#/definitions/ThemeColor" } } }, "Font": { "type": "object", "discriminator": "Type", "description": " Encapsulates the font object used in a spreadsheet.\n ", "additionalProperties": false, "properties": { "Color": { "description": "Gets or sets the of the font.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "DoubleSize": { "type": "number", "description": "Gets and sets the double size of the font.\n ", "format": "double" }, "IsBold": { "type": "boolean", "description": "Gets or sets a value indicating whether the font is bold.\n " }, "IsItalic": { "type": "boolean", "description": "Gets or sets a value indicating whether the font is italic.\n " }, "IsStrikeout": { "type": "boolean", "description": "Gets or sets a value indicating whether the font is single strikeout.\n " }, "IsSubscript": { "type": "boolean", "description": "Gets or sets a value indicating whether the font is subscript.\n " }, "IsSuperscript": { "type": "boolean", "description": "Gets or sets a value indicating whether the font is super script.\n " }, "Name": { "type": "string", "description": "Gets or sets the name of the .\n " }, "Size": { "type": "integer", "description": "Gets or sets the size of the font.\n ", "format": "int32" }, "Underline": { "type": "string", "description": "Gets or sets the font underline type.\n " } } }, "Border": { "type": "object", "description": " Encapsulates the object that represents the cell border.\n ", "additionalProperties": false, "properties": { "LineStyle": { "type": "string", "description": "Gets or sets the cell border type.\n " }, "Color": { "description": "Gets or sets the of the border.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BorderType": { "type": "string", "description": "This class has a property called \"BorderType\" of type string that can be both get and set." }, "ThemeColor": { "description": "Gets and sets the theme color of the border.\n ", "allOf": [ {} ], "$ref": "#/definitions/ThemeColor" }, "ArgbColor": { "type": "integer", "description": "Gets and sets the color with a 32-bit ARGB value.\n ", "format": "int32" } } }, "CellsResponse": { "type": "object", "description": " Represents the Cells Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Cells Response.\n ", "additionalProperties": false, "properties": { "Cells": { "description": "Property Summary: The class has a property called \"Cells\" which is annotated with the [XmlElement(\"cells\")] attribute.", "allOf": [ {} ], "$ref": "#/definitions/Cells" } } } ] }, "Cells": { "type": "object", "description": "Encapsulates a collection of cell relevant objects, such as Aspose.Cells.Cell, Aspose.Cells.Row, ...etc.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Encapsulates a collection of cell relevant objects, such as Aspose.Cells.Cell, Aspose.Cells.Row, ...etc.", "additionalProperties": false, "required": [ "MaxRow", "MaxColumn", "CellCount" ], "properties": { "MaxRow": { "type": "integer", "description": "Maximum row index of cell which contains data or style.\n ", "format": "int32" }, "MaxColumn": { "type": "integer", "description": "Maximum column index of those cells that have been instantiated in the collection(does not include the column\n where style is defined for the whole column but no cell has been instantiated in it).\n ", "format": "int32" }, "CellCount": { "type": "integer", "description": "The class has a public property \"CellCount\" of type integer that can be read and modified.", "format": "int32" }, "Rows": { "description": "Gets the collection of objects that represents the individual rows in this worksheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Columns": { "description": "Gets the collection of objects that represents the individual columns in this worksheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "CellList": { "type": "array", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "StyleResponse": { "type": "object", "description": " Represents the Style Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Style Response.\n ", "additionalProperties": false, "properties": { "Style": { "description": "A property named \"Style\" of type \"Style\" is defined with both getter and setter methods.", "allOf": [ {} ], "$ref": "#/definitions/Style" } } } ] }, "CellResponse": { "type": "object", "description": " Represents the Cell Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Cell Response.\n ", "additionalProperties": false, "properties": { "Cell": { "description": "A property named \"Cell\" of type \"Cell\" that has both a getter and a setter.", "allOf": [ {} ], "$ref": "#/definitions/Cell" } } } ] }, "Cell": { "type": "object", "description": "Encapsulates the object that represents a single Workbook cell.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Encapsulates the object that represents a single Workbook cell.", "additionalProperties": false, "required": [ "Row", "Column", "IsFormula", "IsMerged", "IsArrayHeader", "IsInArray", "IsErrorValue", "IsInTable", "IsStyleSet" ], "properties": { "Name": { "type": "string", "description": "Gets the name of the cell.\n " }, "Row": { "type": "integer", "description": "Gets row number (zero based) of the cell.\n ", "format": "int32" }, "Column": { "type": "integer", "description": "Gets column number (zero based) of the cell.\n ", "format": "int32" }, "Value": { "type": "string", "description": "Gets the value contained in this cell.\n " }, "Type": { "type": "string", "description": "Represents cell value type.\n " }, "Formula": { "type": "string", "description": "Gets or sets a formula of the .\n " }, "IsFormula": { "type": "boolean", "description": "Represents if the specified cell contains formula.\n " }, "IsMerged": { "type": "boolean", "description": "Checks if a cell is part of a merged range or not.\n " }, "IsArrayHeader": { "type": "boolean", "description": "Indicates the cell's formula is and array formula \n and it is the first cell of the array.\n " }, "IsInArray": { "type": "boolean", "description": "Indicates whether the cell formula is an array formula.\n " }, "IsErrorValue": { "type": "boolean", "description": "Checks if the value of this cell is an error.\n " }, "IsInTable": { "type": "boolean", "description": "Indicates whether this cell is part of table formula.\n " }, "IsStyleSet": { "type": "boolean", "description": "Indicates if the cell's style is set. If return false, it means this cell has a default cell format.\n " }, "HtmlString": { "type": "string", "description": "Gets and sets the html string which contains data and some formats in this cell.\n " }, "Style": { "description": "This class property represents a style element with the specified XML element name.", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Worksheet": { "type": "string", "description": "Gets the parent worksheet.\n " } } } ] }, "CalculationOptions": { "type": "object", "description": " Represents options for calculation.\n ", "additionalProperties": false, "properties": { "CalcStackSize": { "type": "integer", "description": "Specifies the stack size for calculating cells recursively.\n ", "format": "int32" }, "IgnoreError": { "type": "boolean", "description": "Indicates whether errors encountered while calculating formulas should be ignored.\n The error may be unsupported function, external links, etc.\n The default value is true.\n " }, "PrecisionStrategy": { "type": "string", "description": "Specifies the strategy for processing precision of calculation.\n " }, "Recursive": { "type": "boolean", "description": "Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells.\n The default value is true.\n " }, "CustomEngine": { "description": "The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.\n ", "allOf": [ {} ], "$ref": "#/definitions/AbstractCalculationEngine" }, "CalculationMonitor": { "description": "The monitor for user to track the progress of formula calculation.\n ", "allOf": [ {} ], "$ref": "#/definitions/AbstractCalculationMonitor" }, "LinkedDataSources": { "type": "array", "description": "Specifies the data sources for external links used in formulas.\n ", "items": { "$ref": "#/definitions/Workbook" } } } }, "AbstractCalculationEngine": { "type": "object", "description": "Represents user's custom calculation engine to extend the default calculation engine of Aspose.Cells.\n ", "additionalProperties": false, "properties": { "IsParamLiteralRequired": { "type": "boolean", "description": "Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false.\n " }, "IsParamArrayModeRequired": { "type": "boolean", "description": "Indicates whether this engine needs the parameter to be calculated in array mode. Default value is false.\n If is required when calculating custom\n functions, this property needs to be set as true.\n " }, "ProcessBuiltInFunctions": { "type": "boolean", "description": "Whether built-in functions that have been supported by the built-in engine\n should be checked and processed by this implementation.\n Default is false.\n If user needs to change the calculation logic of some built-in functions, this property should be set as true.\n Otherwise please leave this property as false for performance consideration.\n " } } }, "AbstractCalculationMonitor": { "type": "object", "description": "Monitor for user to track the progress of formula calculation.\n ", "additionalProperties": false, "properties": { "OriginalValue": { "description": "Gets the old value of the calculated cell. Should be used only in and .\n " }, "ValueChanged": { "type": "boolean", "description": "Whether the cell's value has been changed after the calculation. Should be used only in . \n " }, "CalculatedValue": { "description": "Gets the newly calculated value of the cell. Should be used only in . \n " } } }, "Workbook": { "type": "object", "description": " Represents a root object to create an Excel spreadsheet.\n ", "additionalProperties": false, "properties": { "FileName": { "type": "string", "description": "Gets and sets the current file name.\n " }, "Links": { "type": "array", "description": "A property of type List Link named Links is specified to be serialized as an XmlElement with the tag \"link\".", "items": { "$ref": "#/definitions/Link" } }, "Worksheets": { "description": "Gets the collection in the spreadsheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "DefaultStyle": { "description": "Gets or sets the default object of the workbook.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "DocumentProperties": { "$ref": "#/definitions/LinkElement" }, "Names": { "$ref": "#/definitions/LinkElement" }, "Settings": { "description": "Represents the workbook settings.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "IsWriteProtected": { "type": "string" }, "IsProtected": { "type": "string" }, "IsEncryption": { "type": "string" }, "Password": { "type": "string" } } }, "FontSetting": { "type": "object", "description": " Represents a range of characters within the cell text.\n ", "additionalProperties": false, "required": [ "Length", "StartIndex" ], "properties": { "Font": { "description": "Returns the font of this object.\n ", "allOf": [ {} ], "$ref": "#/definitions/Font" }, "Length": { "type": "integer", "description": "Gets the length of the characters.\n ", "format": "int32" }, "StartIndex": { "type": "integer", "description": "Gets the start index of the characters.\n ", "format": "int32" }, "TextOptions": { "description": "Returns the text options.\n ", "allOf": [ {} ], "$ref": "#/definitions/TextOptions" }, "Type": { "type": "string", "description": "Gets the type of text node.\n " } } }, "TextOptions": { "type": "object", "description": " Represents the text options.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Font" }, { "type": "object", "description": " Represents the text options.\n ", "additionalProperties": false, "properties": { "Fill": { "description": "Represents fill format.", "allOf": [ {} ], "$ref": "#/definitions/FillFormat" }, "Kerning": { "type": "number", "description": "Represents kerning.", "format": "double" }, "Outline": { "description": "Represents outline format.", "allOf": [ {} ], "$ref": "#/definitions/LineFormat" }, "Shadow": { "description": "Represents shadow effect.", "allOf": [ {} ], "$ref": "#/definitions/ShadowEffect" }, "Spacing": { "type": "number", "description": "Represents spacing.", "format": "double" }, "UnderlineColor": { "description": "Represents under line color.", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" } } } ] }, "FillFormat": { "type": "object", "discriminator": "Type", "description": " Encapsulates the object that represents fill formatting for a shape.\n ", "additionalProperties": false, "properties": { "Type": { "type": "string", "description": "Gets and sets the fill type.\n " }, "SolidFill": { "description": "Gets object.\n ", "allOf": [ {} ], "$ref": "#/definitions/SolidFill" }, "PatternFill": { "description": "Gets object.\n ", "allOf": [ {} ], "$ref": "#/definitions/PatternFill" }, "TextureFill": { "description": "Gets object.\n ", "allOf": [ {} ], "$ref": "#/definitions/TextureFill" }, "GradientFill": { "description": "Gets object.\n ", "allOf": [ {} ], "$ref": "#/definitions/GradientFill" }, "ImageData": { "type": "string", "description": "Gets and sets the picture image data.\n " } } }, "SolidFill": { "type": "object", "description": " Encapsulates the object that represents solid fill format\n ", "additionalProperties": false, "properties": { "Color": { "description": "Gets or sets the .\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "CellsColor": { "description": "Gets and sets the object.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "Transparency": { "type": "number", "description": "Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).\n ", "format": "double" } } }, "PatternFill": { "type": "object", "description": " Encapsulates the object that represents pattern fill format\n ", "additionalProperties": false, "properties": { "Pattern": { "type": "string", "description": "Gets or sets the fill pattern type\n " }, "BackgroundCellsColor": { "description": "Gets and sets the foreground object.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "ForegroundCellsColor": { "description": "Gets and sets the foreground object.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "ForegroundColor": { "description": "Gets or sets the foreground .\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BackgroundColor": { "description": "Gets or sets the background of the .\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BackTransparency": { "type": "number", "description": "Gets or sets the transparency of background color.\n ", "format": "double" }, "ForeTransparency": { "type": "number", "description": "Gets or sets the transparency of foreground color.\n ", "format": "double" } } }, "TextureFill": { "type": "object", "description": " Encapsulates the object that represents texture fill format\n ", "additionalProperties": false, "properties": { "Type": { "type": "string", "description": "Gets and sets the texture type\n " }, "Transparency": { "type": "number", "description": "Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).\n ", "format": "double" }, "Scale": { "type": "number", "description": "Gets and sets the picture format scale.\n ", "format": "double" }, "TilePicOption": { "description": "Gets or sets tile picture option.\n ", "allOf": [ {} ], "$ref": "#/definitions/TilePicOption" }, "PicFormatOption": { "description": "Gets or sets picture format option.\n ", "allOf": [ {} ], "$ref": "#/definitions/PicFormatOption" }, "Image": { "description": "The class has a public property named \"Image\" of type LinkElement that can be accessed and set.", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" } } }, "TilePicOption": { "type": "object", "description": " Represents tile picture as texture.\n ", "additionalProperties": false, "required": [ "OffsetX", "OffsetY", "ScaleX", "ScaleY" ], "properties": { "OffsetX": { "type": "number", "description": "Gets or sets the X offset for tiling picture.\n ", "format": "double" }, "OffsetY": { "type": "number", "description": "Gets or sets the Y offset for tiling picture.\n ", "format": "double" }, "ScaleX": { "type": "number", "description": "Gets or sets the X scale for tiling picture.\n ", "format": "double" }, "ScaleY": { "type": "number", "description": "Gets or sets the Y scale for tiling picture.\n ", "format": "double" }, "AlignmentType": { "type": "string", "description": "Gets or sets the alignment for tiling.\n " }, "MirrorType": { "type": "string", "description": "Gets or sets the mirror type for tiling.\n " } } }, "PicFormatOption": { "type": "object", "description": " Represents picture format option\n ", "additionalProperties": false, "properties": { "Type": { "type": "string", "description": "Gets or sets the picture fill type.\n " }, "Scale": { "type": "number", "description": "Gets or sets how many the picture stack and scale with.\n ", "format": "double" }, "Left": { "type": "number", "description": "Gets or sets the left offset for stretching picture.\n ", "format": "double" }, "Right": { "type": "number", "description": "Gets or sets the right offset for stretching picture.\n ", "format": "double" }, "Top": { "type": "number", "description": "Gets or sets the top offset for stretching picture.\n ", "format": "double" }, "Bottom": { "type": "number", "description": "Gets or sets the bottom offset for stretching picture.\n ", "format": "double" } } }, "GradientFill": { "type": "object", "description": " Represents the gradient fill.\n ", "additionalProperties": false, "properties": { "FillType": { "type": "string", "description": "Gets the gradient fill type.\n " }, "DirectionType": { "type": "string", "description": "Gets the gradient direction type.\n " }, "Angle": { "type": "number", "description": "The angle of linear fill.\n ", "format": "double" }, "GradientStops": { "type": "array", "description": "Represents the gradient stop collection.\n ", "items": { "$ref": "#/definitions/GradientFillStop" } } } }, "GradientFillStop": { "type": "object", "description": "Class summary: Understanding the various features and tools available in Adobe Illustrator to create dynamic and professional vector graphics, including shapes, text, brushes, gradients, and layers.", "additionalProperties": false, "required": [ "Position", "Transparency" ], "properties": { "Color": { "description": "Color property of type DTO.Color that has a getter and a setter.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Position": { "type": "number", "format": "double" }, "Transparency": { "type": "number", "format": "double" } } }, "LineFormat": { "type": "object", "description": " Represents all setting of the line.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/FillFormat" }, { "type": "object", "description": " Represents all setting of the line.\n ", "additionalProperties": false, "properties": { "BeginArrowheadLength": { "type": "string", "description": "Gets and sets the begin arrow length type of the line.\n " }, "BeginArrowheadStyle": { "type": "string", "description": "Gets and sets the begin arrow type of the line.\n " }, "BeginArrowheadWidth": { "type": "string", "description": "Gets and sets the begin arrow width type of the line.\n " }, "CapType": { "type": "string", "description": "Specifies the ending caps.\n " }, "CompoundType": { "type": "string", "description": "Specifies the line compound type.\n " }, "DashStyle": { "type": "string", "description": "Specifies the line dash type.\n " }, "EndArrowheadLength": { "type": "string", "description": "Gets and sets the end arrow length type of the line.\n " }, "EndArrowheadStyle": { "type": "string", "description": "Gets and sets the end arrow type of the line.\n " }, "EndArrowheadWidth": { "type": "string", "description": "Gets and sets the end arrow width type of the line.\n " }, "JoinType": { "type": "string", "description": "Specifies the line join type.\n " }, "Weight": { "type": "number", "description": "Gets or sets the weight of the line in unit of points.\n ", "format": "double" } } } ] }, "ShadowEffect": { "type": "object", "description": " This class specifies the shadow effect of the chart element or shape.\n ", "additionalProperties": false, "properties": { "Angle": { "type": "number", "description": "Gets and sets the lighting angle. Range from 0 to 359.9 degrees.\n ", "format": "double" }, "Blur": { "type": "number", "description": "Gets and sets the blur of the shadow. Range from 0 to 100 points.\n ", "format": "double" }, "Color": { "description": "Gets and sets the color of the shadow.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "Distance": { "type": "number", "description": "Gets and sets the distance of the shadow. Range from 0 to 200 points.\n ", "format": "double" }, "PresetType": { "type": "string", "description": "Gets and sets the preset shadow type of the shadow.\n " }, "Size": { "type": "number", "description": "Gets and sets the size of the shadow. Range from 0 to 2.0. \n Meaningless in inner shadow.\n ", "format": "double" }, "Transparency": { "type": "number", "description": "Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).\n ", "format": "double" } } }, "ColumnsResponse": { "type": "object", "description": " Represents the Columns Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Columns Response.\n ", "additionalProperties": false, "properties": { "Columns": { "description": "This property allows access to the columns within the class.", "allOf": [ {} ], "$ref": "#/definitions/Columns" } } } ] }, "Columns": { "type": "object", "description": "Columns ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Columns ", "additionalProperties": false, "required": [ "MaxColumn", "ColumnsCount" ], "properties": { "MaxColumn": { "type": "integer", "description": "The max column index.", "format": "int32" }, "ColumnsCount": { "type": "integer", "description": "Column count.", "format": "int32" }, "ColumnsList": { "type": "array", "description": "Columns list.", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "ColumnResponse": { "type": "object", "description": " Represents the Column Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Column Response.\n ", "additionalProperties": false, "properties": { "Column": { "description": "This class has a public property called \"Column\" of type \"Column\" with both getter and setter methods.", "allOf": [ {} ], "$ref": "#/definitions/Column" } } } ] }, "Column": { "type": "object", "description": " Represents a single column in a worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a single column in a worksheet.\n ", "additionalProperties": false, "properties": { "GroupLevel": { "type": "integer", "description": "Gets the group level of the column.\n ", "format": "int32" }, "Index": { "type": "integer", "description": "Gets the index of this column.\n ", "format": "int32" }, "IsHidden": { "type": "boolean", "description": "Indicates whether the column is hidden.\n " }, "Width": { "type": "number", "description": "Gets and sets the column width in unit of characters.\n ", "format": "double" }, "Style": { "description": "Gets the style of this column.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" } } } ] }, "RowsResponse": { "type": "object", "description": " Represents the Rows Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Rows Response.\n ", "additionalProperties": false, "properties": { "Rows": { "description": "A property named \"Rows\" of type \"Rows\" which has both getter and setter methods.", "allOf": [ {} ], "$ref": "#/definitions/Rows" } } } ] }, "Rows": { "type": "object", "description": " Collects the objects that represent the individual rows in a worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Collects the objects that represent the individual rows in a worksheet.\n ", "additionalProperties": false, "required": [ "MaxRow", "RowsCount" ], "properties": { "MaxRow": { "type": "integer", "description": "This property allows access to set and retrieve the maximum row value in the class.", "format": "int32" }, "RowsCount": { "type": "integer", "format": "int32" }, "RowsList": { "type": "array", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "RowResponse": { "type": "object", "description": " Represents the Row Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Row Response.\n ", "additionalProperties": false, "properties": { "Row": { "description": "This class has a public property named \"Row\" of type \"Row\" with both get and set accessors.", "allOf": [ {} ], "$ref": "#/definitions/Row" } } } ] }, "Row": { "type": "object", "description": " Represents a single row in a worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a single row in a worksheet.\n ", "additionalProperties": false, "properties": { "GroupLevel": { "type": "integer", "description": "Gets the group level of the row.\n ", "format": "int32" }, "Height": { "type": "number", "description": "Gets and sets the row height in unit of Points.\n ", "format": "double" }, "Index": { "type": "integer", "description": "Gets the index of this row.\n ", "format": "int32" }, "IsBlank": { "type": "boolean", "description": "Indicates whether the row contains any data\n " }, "IsHeightMatched": { "type": "boolean", "description": "Indicates that row height and default font height matches.\n " }, "IsHidden": { "type": "boolean", "description": "Indicates whether the row is hidden.\n " }, "Style": { "description": "Represents the style of this row.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" } } } ] }, "ChartAreaResponse": { "type": "object", "description": " Represents the ChartArea Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the ChartArea Response.\n ", "additionalProperties": false, "properties": { "ChartArea": { "description": "This class has a property named \"ChartArea\" of type ChartArea with a getter and setter.", "allOf": [ {} ], "$ref": "#/definitions/ChartArea" } } } ] }, "ChartArea": { "type": "object", "description": " Encapsulates the object that represents the chart area in the worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChartFrame" }, { "type": "object", "description": " Encapsulates the object that represents the chart area in the worksheet.\n ", "additionalProperties": false } ] }, "ChartFrame": { "type": "object", "discriminator": "Type", "description": " Encapsulates the object that represents the frame object in a chart.\n ", "additionalProperties": false, "properties": { "Area": { "description": "Gets the area.\n ", "allOf": [ {} ], "$ref": "#/definitions/Area" }, "AutoScaleFont": { "type": "boolean", "description": "True if the text in the object changes font size when the object size changes. The default value is True.\n " }, "BackgroundMode": { "type": "string", "description": "Gets and sets the display mode of the background\n " }, "Border": { "description": "Gets the border.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "Font": { "description": "Gets a object of the specified ChartFrame object.\n ", "allOf": [ {} ], "$ref": "#/definitions/Font" }, "IsAutomaticSize": { "type": "boolean", "description": "Indicates whether the chart frame is automatic sized.\n " }, "IsInnerMode": { "type": "boolean", "description": "Indicates whether the size of the plot area size includes the tick marks, and the axis labels.\n False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.\n " }, "Shadow": { "type": "boolean", "description": "True if the frame has a shadow.\n " }, "Width": { "type": "integer", "description": "Gets or sets the width of frame in units of 1/4000 of the chart area.\n ", "format": "int32" }, "Height": { "type": "integer", "description": "Gets or sets the height of frame in units of 1/4000 of the chart area.\n ", "format": "int32" }, "X": { "type": "integer", "description": "Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.\n ", "format": "int32" }, "Y": { "type": "integer", "description": "Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.\n ", "format": "int32" } } }, "Area": { "type": "object", "discriminator": "Type", "description": " Encapsulates the object that represents an area format.\n ", "additionalProperties": false, "properties": { "BackgroundColor": { "description": "Gets or sets the background of the .\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "FillFormat": { "description": "Represents a object that contains fill formatting properties for the specified chart or shape.\n ", "allOf": [ {} ], "$ref": "#/definitions/FillFormat" }, "ForegroundColor": { "description": "Gets or sets the foreground .\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Format": { "type": "string", "description": "This class has a property named \"Format\" of type string with both getter and setter methods." }, "InvertIfNegative": { "type": "boolean", "description": "If the property is true and the value of chart point is a negative number,\n the foreground color and background color will be exchanged.\n " }, "Transparency": { "type": "number", "description": "Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).\n ", "format": "double" } } }, "Line": { "type": "object", "discriminator": "Type", "description": "Encapsulates the object that represents the line format.", "additionalProperties": false, "properties": { "BeginArrowLength": { "type": "string", "description": "Specifies the length of the arrowhead for the begin of a line.\n " }, "BeginArrowWidth": { "type": "string", "description": "Specifies the width of the arrowhead for the begin of a line.\n " }, "BeginType": { "type": "string", "description": "Specifies an arrowhead for the begin of a line.\n " }, "CapType": { "type": "string", "description": "Specifies the ending caps.\n " }, "Color": { "description": "Represents the of the line.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "CompoundType": { "type": "string", "description": "Specifies the compound line type\n " }, "DashType": { "type": "string", "description": "Specifies the dash line type\n " }, "EndArrowLength": { "type": "string", "description": "Specifies the length of the arrowhead for the end of a line.\n " }, "EndArrowWidth": { "type": "string", "description": "Specifies the width of the arrowhead for the end of a line.\n " }, "EndType": { "type": "string", "description": "Specifies an arrowhead for the end of a line.\n " }, "GradientFill": { "description": "Represents gradient fill.\n ", "allOf": [ {} ], "$ref": "#/definitions/GradientFill" }, "IsAuto": { "type": "boolean", "description": "Indicates whether this line style is auto assigned.\n " }, "IsAutomaticColor": { "type": "boolean", "description": "Indicates whether the color of line is automatic assigned.\n " }, "IsVisible": { "type": "boolean", "description": "Represents whether the line is visible.\n " }, "JoinType": { "type": "string", "description": "Specifies the joining caps.\n " }, "Style": { "type": "string", "description": "Represents the style of the line.\n " }, "Transparency": { "type": "number", "description": "Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).\n ", "format": "double" }, "Weight": { "type": "string", "description": "Gets or sets the of the line.\n " }, "WeightPt": { "type": "number", "description": "Gets or sets the weight of the line in unit of points.\n ", "format": "double" } } }, "FillFormatResponse": { "type": "object", "description": " Represents the FillFormat Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the FillFormat Response.\n ", "additionalProperties": false, "properties": { "FillFormat": { "description": "Property Summary: Allows access to the FillFormat property to get or set fill formatting properties for an object.", "allOf": [ {} ], "$ref": "#/definitions/FillFormat" } } } ] }, "LineResponse": { "type": "object", "description": " Represents the Line Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Line Response.\n ", "additionalProperties": false, "properties": { "Line": { "description": "A public property named \"Line\" of type Line with both getter and setter methods.", "allOf": [ {} ], "$ref": "#/definitions/Line" } } } ] }, "ChartsResponse": { "type": "object", "description": " Represents the Charts Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Charts Response.\n ", "additionalProperties": false, "properties": { "Charts": { "description": "Property Summary: Includes an XML element named \"charts\" that contains a property of type Charts.Charts.", "allOf": [ {} ], "$ref": "#/definitions/Charts" } } } ] }, "Charts": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "properties": { "ChartList": { "type": "array", "description": "A property named ChartList of type List LinkElement that is publicly accessible with both read and write capabilities.", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "Chart": { "type": "object", "description": " Encapsulates the object that represents a single Excel chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates the object that represents a single Excel chart.\n ", "additionalProperties": false, "properties": { "AutoScaling": { "type": "boolean", "description": "True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. \n The RightAngleAxes property must be True.\n " }, "BackWall": { "description": "Returns a object that represents the back wall of a 3-D chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/Walls" }, "CategoryAxis": { "description": "Gets the chart's X axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/Axis" }, "ChartArea": { "description": "Gets the chart area in the worksheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/ChartArea" }, "ChartDataTable": { "description": "Represents the chart data table.\n ", "allOf": [ {} ], "$ref": "#/definitions/ChartDataTable" }, "ChartObject": { "description": "Represents the chartShape;\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "DepthPercent": { "type": "integer", "description": "Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).\n ", "format": "int32" }, "Elevation": { "type": "integer", "description": "Represents the elevation of the 3-D chart view, in degrees.\n ", "format": "int32" }, "FirstSliceAngle": { "type": "integer", "description": "Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). \n Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.\n ", "format": "int32" }, "Floor": { "description": "Returns a object that represents the walls of a 3-D chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/Floor" }, "GapDepth": { "type": "integer", "description": "Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.\n The value of this property must be between 0 and 500.\n ", "format": "int32" }, "GapWidth": { "type": "integer", "description": "Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.\n The value of this property must be between 0 and 500.\n ", "format": "int32" }, "HeightPercent": { "type": "integer", "description": "Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).\n ", "format": "int32" }, "HidePivotFieldButtons": { "type": "boolean", "description": "Indicates whether hide the pivot chart field buttons only when the chart is PivotChart.\n " }, "Is3D": { "type": "boolean", "description": "Indicates whether the chart is a 3d chart.\n " }, "IsRectangularCornered": { "type": "boolean", "description": "Gets or sets a value indicating whether the chart area is rectangular cornered.\n Default is true.\n " }, "Legend": { "description": "Gets the chart legend.\n ", "allOf": [ {} ], "$ref": "#/definitions/Legend" }, "Name": { "type": "string", "description": "Gets and sets the name of the chart.\n " }, "NSeries": { "description": "Gets a collection representing the data series in the chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/SeriesItems" }, "PageSetup": { "description": "Represents the page setup description in this chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Perspective": { "type": "integer", "description": "Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100.\n This property is ignored if the RightAngleAxes property is True.\n " }, "PivotSource": { "type": "string", "description": "The source is the data of the pivotTable.\n If PivotSource is not empty ,the chart is PivotChart.\n " }, "Placement": { "type": "string", "description": "Represents the way the chart is attached to the cells below it.\n " }, "PlotArea": { "description": "Gets the chart's plot area which includes axis tick labels.\n ", "allOf": [ {} ], "$ref": "#/definitions/PlotArea" }, "PlotEmptyCellsType": { "type": "string", "description": "Gets and sets how to plot the empty cells.\n " }, "PlotVisibleCells": { "type": "boolean", "description": "Indicates whether only plot visible cells.\n " }, "PrintSize": { "type": "string", "description": "Gets and sets the printed chart size.\n " }, "RightAngleAxes": { "type": "boolean", "description": "True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts).\n " }, "RotationAngle": { "type": "integer", "description": "Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).\n ", "format": "int32" }, "SecondCategoryAxis": { "description": "Gets the chart's second X axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "SecondValueAxis": { "description": "Gets the chart's second Y axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "SeriesAxis": { "description": "Gets the chart's series axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Shapes": { "description": "Returns all drawing shapes in this chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "ShowDataTable": { "type": "boolean", "description": "Gets or sets a value indicating whether the chart displays a data table.\n " }, "ShowLegend": { "type": "boolean", "description": "Gets or sets a value indicating whether the chart legend will be displayed. Default is true.\n " }, "SideWall": { "description": "Returns a object that represents the side wall of a 3-D chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "SizeWithWindow": { "type": "boolean", "description": "True if Microsoft Excel resizes the chart to match the size of the chart sheet window.\n " }, "Style": { "type": "integer", "description": "Gets and sets the builtin style.\n ", "format": "int32" }, "Title": { "description": "Gets the chart's title.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Type": { "type": "string", "description": "Gets or sets a chart's type.\n " }, "ValueAxis": { "description": "Gets the chart's Y axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/Axis" }, "Walls": { "description": "Returns a object that represents the walls of a 3-D chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "WallsAndGridlines2D": { "type": "boolean", "description": "True if gridlines are drawn two-dimensionally on a 3-D chart.\n " } } } ] }, "Walls": { "type": "object", "description": " Encapsulates the object that represents the walls of a 3-D chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Floor" }, { "type": "object", "description": " Encapsulates the object that represents the walls of a 3-D chart.\n ", "additionalProperties": false, "properties": { "CenterX": { "type": "integer", "description": "Gets the x coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's width after calls Chart.Calculate() method.\n ", "format": "int32" }, "CenterY": { "type": "integer", "description": "Gets the y coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's height after calls Chart.Calculate() method.\n ", "format": "int32" }, "Depth": { "type": "integer", "description": "Gets the depth front to back in units of 1/4000 of chart's width after calls Chart.Calculate() method.\n ", "format": "int32" }, "Height": { "type": "integer", "description": "Gets the height of top to bottom in units of 1/4000 of chart's height after calls Chart.Calculate() method.\n ", "format": "int32" }, "Width": { "type": "integer", "description": "Gets the width of left to right in units of 1/4000 of chart's width after calls Chart.Calculate() method.\n ", "format": "int32" } } } ] }, "Floor": { "type": "object", "discriminator": "Type", "description": " Encapsulates the object that represents the floor of a 3-D chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Area" }, { "type": "object", "description": " Encapsulates the object that represents the floor of a 3-D chart.\n ", "additionalProperties": false, "properties": { "Border": { "description": "Gets or sets the border .\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" } } } ] }, "Axis": { "type": "object", "description": " Encapsulates the object that represents an axis of chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates the object that represents an axis of chart.\n ", "additionalProperties": false, "properties": { "Area": { "description": "Gets the .\n ", "allOf": [ {} ], "$ref": "#/definitions/Area" }, "AxisBetweenCategories": { "type": "boolean", "description": "Represents if the value axis crosses the category axis between categories.\n " }, "AxisLine": { "description": "Gets the appearance of an Axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "BaseUnitScale": { "type": "string", "description": "Represents the base unit scale for the category axis.\n " }, "CategoryType": { "type": "string", "description": "Represents the category axis type.\n " }, "CrossAt": { "type": "number", "description": "Represents the point on the value axis where the category axis crosses it.\n ", "format": "double" }, "CrossType": { "type": "string", "description": "Represents the on the specified axis where the other axis crosses.\n " }, "DisplayUnit": { "type": "string", "description": "Represents the unit label for the specified axis.\n " }, "DisplayUnitLabel": { "description": "Represents a unit label on an axis in the specified chart. \n Unit labels are useful for charting large values— for example, in the millions or billions.\n ", "allOf": [ {} ], "$ref": "#/definitions/DisplayUnitLabel" }, "HasMultiLevelLabels": { "type": "boolean", "description": "Indicates whether the labels shall be shown as multi level.\n " }, "IsAutomaticMajorUnit": { "type": "boolean", "description": "Indicates whether the major unit of the axis is automatically assigned.\n " }, "IsAutomaticMaxValue": { "type": "boolean", "description": "Indicates whether the max value is automatically assigned.\n " }, "IsAutomaticMinorUnit": { "type": "boolean", "description": "Indicates whether the minor unit of the axis is automatically assigned.\n " }, "IsAutomaticMinValue": { "type": "boolean", "description": "Indicates whether the min value is automatically assigned.\n " }, "IsDisplayUnitLabelShown": { "type": "boolean", "description": "Represents if the display unit label is shown on the specified axis.\n " }, "IsLogarithmic": { "type": "boolean", "description": "Represents if the value axis scale type is logarithmic or not.\n " }, "IsPlotOrderReversed": { "type": "boolean", "description": "Represents if Microsoft Excel plots data points from last to first.\n " }, "IsVisible": { "type": "boolean", "description": "Represents if the axis is visible.\n " }, "LogBase": { "type": "number", "description": "Represents the logarithmic base. Default value is 10.Only applies for Excel2007.\n ", "format": "double" }, "MajorGridLines": { "description": "Represents major gridlines on a chart axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "MajorTickMark": { "type": "string", "description": "Represents the type of major tick mark for the specified axis.\n " }, "MajorUnit": { "type": "number", "description": "Represents the major units for the axis.\n ", "format": "double" }, "MajorUnitScale": { "type": "string", "description": "Represents the major unit scale for the category axis.\n " }, "MaxValue": { "type": "number", "description": "Represents the maximum value on the value axis.\n ", "format": "double" }, "MinorGridLines": { "description": "Represents minor gridlines on a chart axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "MinorTickMark": { "type": "string", "description": "Represents the type of minor tick mark for the specified axis.\n " }, "MinorUnit": { "type": "number", "description": "Represents the minor units for the axis.\n ", "format": "double" }, "MinorUnitScale": { "type": "string", "description": "Represents the major unit scale for the category axis.\n " }, "MinValue": { "type": "number", "description": "Represents the minimum value on the value axis.\n ", "format": "double" }, "TickLabelPosition": { "type": "string", "description": "Represents the position of tick-mark labels on the specified axis.\n " }, "TickLabels": { "description": "Returns a object that represents the tick-mark labels for the specified axis.\n ", "allOf": [ {} ], "$ref": "#/definitions/TickLabels" }, "TickLabelSpacing": { "type": "integer", "description": "Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.\n ", "format": "int32" }, "TickMarkSpacing": { "type": "integer", "description": "Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.\n ", "format": "int32" }, "Title": { "description": "Gets the axis' title.\n ", "allOf": [ {} ], "$ref": "#/definitions/Title" } } } ] }, "DisplayUnitLabel": { "type": "object", "description": " Represents the display unit label.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChartFrame" }, { "type": "object", "description": " Represents the display unit label.\n ", "additionalProperties": false, "required": [ "RotationAngle" ], "properties": { "LinkedSource": { "type": "string", "description": "A public property named \"LinkedSource\" with a string data type can be set and accessed." }, "RotationAngle": { "type": "integer", "format": "int32" }, "Text": { "type": "string", "description": "Gets or sets the text of display unit label.\n " }, "TextHorizontalAlignment": { "type": "string" }, "TextVerticalAlignment": { "type": "string" } } } ] }, "TickLabels": { "type": "object", "description": " Represents the tick-mark labels associated with tick marks on a chart axis.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents the tick-mark labels associated with tick marks on a chart axis.\n ", "additionalProperties": false, "properties": { "AutoScaleFont": { "type": "boolean", "description": "True if the text in the object changes font size when the object size changes. The default value is True.\n " }, "BackgroundMode": { "type": "string", "description": "Gets and sets the display mode of the background\n " }, "Font": { "description": "Returns a object that represents the font of the specified TickLabels object.\n ", "allOf": [ {} ], "$ref": "#/definitions/Font" }, "Number": { "type": "integer", "description": "Represents the format number for the TickLabels object.\n ", "format": "int32" }, "NumberFormat": { "type": "string", "description": "Represents the format string for the TickLabels object.\n " }, "NumberFormatLinked": { "type": "boolean", "description": "True if the number format is linked to the cells \n (so that the number format changes in the labels when it changes in the cells).\n " }, "Offset": { "type": "integer", "description": "Gets and sets the distance of labels from the axis.\n ", "format": "int32" }, "RotationAngle": { "type": "integer", "description": "Represents text rotation angle in clockwise.\n ", "format": "int32" }, "TextDirection": { "type": "string", "description": "Represents text reading order.\n " }, "ReadingOrder": { "type": "string", "description": "Represents text reading order.\n " }, "DirectionType": { "type": "string", "description": "Gets and sets the direction of text.\n " } } } ] }, "Title": { "type": "object", "description": " Encapsulates the object that represents the title of chart or axis.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChartFrame" }, { "type": "object", "description": " Encapsulates the object that represents the title of chart or axis.\n ", "additionalProperties": false, "properties": { "IsVisible": { "type": "boolean", "description": "Represents whether the title is visible.\n " }, "LinkedSource": { "type": "string", "description": "A property named LinkedSource with both set and get accessors is defined." }, "RotationAngle": { "type": "integer", "format": "int32" }, "Text": { "type": "string", "description": "Gets or sets the text of display unit label.\n " }, "TextDirection": { "type": "string" }, "TextHorizontalAlignment": { "type": "string" }, "TextVerticalAlignment": { "type": "string" } } } ] }, "ChartDataTable": { "type": "object", "description": " Represents a chart data table.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a chart data table.\n ", "additionalProperties": false, "properties": { "AutoScaleFont": { "type": "boolean", "description": "True if the text in the object changes font size when the object size changes. \n The default value is True.\n " }, "BackgroundMode": { "type": "string", "description": "Gets and sets the display mode of the background\n " }, "Border": { "description": "Returns a Border object that represents the border of the object\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "Font": { "description": "Gets a object which represents the font setting of the specified chart data table.\n ", "allOf": [ {} ], "$ref": "#/definitions/Font" }, "HasBorderHorizontal": { "type": "boolean", "description": "True if the chart data table has horizontal cell borders\n " }, "HasBorderOutline": { "type": "boolean", "description": "True if the chart data table has outline borders\n " }, "HasBorderVertical": { "type": "boolean", "description": "True if the chart data table has vertical cell borders\n " }, "ShowLegendKey": { "type": "boolean", "description": "True if the data label legend key is visible.\n " } } } ] }, "Legend": { "type": "object", "description": " Encapsulates the object that represents the chart legend.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChartFrame" }, { "type": "object", "description": " Encapsulates the object that represents the chart legend.\n ", "additionalProperties": false, "properties": { "Position": { "type": "string", "description": "Gets or sets the legend position type.\n " }, "LegendEntries": { "description": "Gets a collection of all the LegendEntry objects in the specified chart legend.\n Setting the legend entries of the surface chart is not supported.\n So it will return null if the chart type is surface chart type.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" } } } ] }, "SeriesItems": { "type": "object", "description": "Class Summary: \n- Features: Active class participation, group projects, quizzes, and final exam.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Class Summary: \n- Features: Active class participation, group projects, quizzes, and final exam.", "additionalProperties": false, "properties": { "CategoryData": { "type": "string", "description": "This property allows setting and getting data for the category." }, "IsColorVaried": { "type": "boolean" }, "SecondCatergoryData": { "type": "string" }, "SeriesList": { "type": "array", "items": { "$ref": "#/definitions/Series" } } } } ] }, "Series": { "type": "object", "description": " Encapsulates the object that represents a single data series in a chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates the object that represents a single data series in a chart.\n ", "additionalProperties": false, "required": [ "CountOfDataValues" ], "properties": { "Area": { "description": "Represents the background area of Series object.\n ", "allOf": [ {} ], "$ref": "#/definitions/Area" }, "Bar3DShapeType": { "type": "string", "description": "Gets or sets the 3D shape type used with the 3-D bar or column chart.\n " }, "Border": { "description": "Represents border of Series object.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "BubbleScale": { "type": "integer", "description": "Gets or sets the scale factor for bubbles in the specified chart group. \n It can be an integer value from 0 (zero) to 300, \n corresponding to a percentage of the default size.\n Applies only to bubble charts.\n ", "format": "int32" }, "BubbleSizes": { "type": "string", "description": "Gets or sets the bubble sizes values of the chart series.\n " }, "CountOfDataValues": { "type": "integer", "description": "Gets the number of the data values.\n ", "format": "int32" }, "DataLabels": { "description": "Represents the DataLabels object for the specified ASeries.\n ", "allOf": [ {} ], "$ref": "#/definitions/DataLabels" }, "DisplayName": { "type": "string", "description": "Gets the series's name that displays on the chart graph.\n " }, "DoughnutHoleSize": { "type": "integer", "description": "Returns or sets the size of the hole in a doughnut chart group. \n The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.\n ", "format": "int32" }, "DownBars": { "description": "Returns a object that represents the down bars on a line chart.\n Applies only to line charts.\n ", "allOf": [ {} ], "$ref": "#/definitions/DropBars" }, "DropLines": { "description": "Returns a object that represents the drop lines for a series on the line chart or area chart.\n Applies only to line chart or area charts.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "Explosion": { "type": "integer", "description": "The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.\n ", "format": "int32" }, "FirstSliceAngle": { "type": "integer", "description": "Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). \n Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.\n " }, "GapWidth": { "type": "integer", "description": "Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.\n The value of this property must be between 0 and 500.\n " }, "Has3DEffect": { "type": "boolean", "description": "True if the series has a three-dimensional appearance. \n Applies only to bubble charts.\n " }, "HasDropLines": { "type": "boolean", "description": "True if the chart has drop lines.\n Applies only to line chart or area charts.\n " }, "HasHiLoLines": { "type": "boolean", "description": "True if the line chart has high-low lines. \n Applies only to line charts.\n " }, "HasLeaderLines": { "type": "boolean", "description": "True if the series has leader lines.\n " }, "HasRadarAxisLabels": { "type": "boolean", "description": "True if a radar chart has category axis labels. Applies only to radar charts.\n " }, "HasSeriesLines": { "type": "boolean", "description": "True if a stacked column chart or bar chart has series lines or\n if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections. \n Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.\n " }, "HasUpDownBars": { "type": "boolean", "description": "True if a line chart has up and down bars.\n Applies only to line charts.\n " }, "HiLoLines": { "description": "Returns a HiLoLines object that represents the high-low lines for a series on a line chart. \n Applies only to line charts.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "IsAutoSplit": { "type": "boolean", "description": "Indicates whether the threshold value is automatic.\n " }, "IsColorVaried": { "type": "boolean", "description": "Represents if the color of points is varied. \n The chart must contain only one series.\n " }, "LeaderLines": { "description": "Represents leader lines on a chart. Leader lines connect data labels to data points. \n This object isn’t a collection; there’s no object that represents a single leader line.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "LegendEntry": { "description": "Gets the legend entry according to this series.\n ", "allOf": [ {} ], "$ref": "#/definitions/LegendEntry" }, "Marker": { "description": "Gets the marker.\n ", "allOf": [ {} ], "$ref": "#/definitions/Marker" }, "Name": { "type": "string", "description": "Gets or sets the name of the data series.\n " }, "Overlap": { "type": "integer", "description": "Specifies how bars and columns are positioned.\n Can be a value between – 100 and 100. \n Applies only to 2-D bar and 2-D column charts.\n " }, "PlotOnSecondAxis": { "type": "boolean", "description": "Indicates if this series is plotted on second value axis.\n " }, "Points": { "description": "Gets the collection of points in a series in a chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "SecondPlotSize": { "type": "integer", "description": "Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, \n as a percentage of the size of the primary pie.\n Can be a value from 5 to 200.\n " }, "SeriesLines": { "description": "Returns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart.\n Applies only to stacked bar and stacked column charts.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "Shadow": { "type": "boolean", "description": "True if the series has a shadow.\n " }, "ShowNegativeBubbles": { "type": "boolean", "description": "True if negative bubbles are shown for the chart group. Valid only for bubble charts.\n " }, "SizeRepresents": { "type": "string", "description": "Gets or sets what the bubble size represents on a bubble chart.\n " }, "Smooth": { "type": "boolean", "description": "Represents curve smoothing. \n True if curve smoothing is turned on for the line chart or scatter chart.\n Applies only to line and scatter connected by lines charts.\n " }, "SplitType": { "type": "string", "description": "Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of\n pie chart.\n " }, "SplitValue": { "type": "number", "description": "Returns or sets a value that shall be used to determine which data points are in the second pie or bar on\n a pie of pie or bar of pie chart.\n ", "format": "double" }, "TrendLines": { "description": "Returns an object that represents a collection of all the trendlines for the series.\n ", "allOf": [ {} ], "$ref": "#/definitions/Trendlines" }, "Type": { "type": "string", "description": "Gets or sets a data series' type.\n " }, "UpBars": { "description": "Returns an DropBars object that represents the up bars on a line chart.\n Applies only to line charts.\n ", "allOf": [ {} ], "$ref": "#/definitions/DropBars" }, "Values": { "type": "string", "description": "Represents the data of the chart series.\n " }, "XErrorBar": { "description": "Represents X direction error bar of the series.\n ", "allOf": [ {} ], "$ref": "#/definitions/ErrorBar" }, "XValues": { "type": "string", "description": "Represents the x values of the chart series.\n " }, "YErrorBar": { "description": "Represents Y direction error bar of the series.\n ", "allOf": [ {} ], "$ref": "#/definitions/ErrorBar" } } } ] }, "DataLabels": { "type": "object", "description": " Encapsulates a collection of all the DataLabel objects for the specified Series.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChartFrame" }, { "type": "object", "description": " Encapsulates a collection of all the DataLabel objects for the specified Series.\n ", "additionalProperties": false, "properties": { "IsAutoText": { "type": "boolean", "description": "Indicates the text is auto generated.\n " }, "IsDeleted": { "type": "boolean", "description": "A nullable boolean property \"IsDeleted\" indicating whether an object has been deleted." }, "LinkedSource": { "type": "string" }, "Number": { "type": "integer", "description": "Gets and sets the built-in number format.\n ", "format": "int32" }, "NumberFormat": { "type": "string", "description": "Represents the format string for the DataLabels object.\n " }, "NumberFormatLinked": { "type": "boolean", "description": "True if the number format is linked to the cells \n (so that the number format changes in the labels when it changes in the cells).\n " }, "Position": { "type": "string", "description": "Represents the position of the data label.\n " }, "RotationAngle": { "type": "integer", "format": "int32" }, "Separator": { "type": "string", "description": "Gets or sets the separator type used for the data labels on a chart.\n " }, "ShowBubbleSize": { "type": "boolean", "description": "Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.\n " }, "ShowCategoryName": { "type": "boolean", "description": "Represents a specified chart's data label category name display behavior.True to display the category name for the data labels on a chart. False to hide.\n " }, "ShowLegendKey": { "type": "boolean", "description": "Represents a specified chart's data label legend key display behavior.\n True if the data label legend key is visible.\n " }, "ShowPercentage": { "type": "boolean", "description": "Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.\n " }, "ShowSeriesName": { "type": "boolean", "description": "Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.\n True to show the series name. False to hide.\n " }, "ShowValue": { "type": "boolean", "description": "Represents a specified chart's data label values display behavior. True displays the values. False to hide.\n " }, "Text": { "type": "string", "description": "Gets or sets the text of data label.\n " }, "TextDirection": { "type": "string" }, "TextHorizontalAlignment": { "type": "string" }, "TextVerticalAlignment": { "type": "string" } } } ] }, "DropBars": { "type": "object", "description": " Represents the up/down bars in a chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents the up/down bars in a chart.\n ", "additionalProperties": false, "properties": { "Area": { "description": "Gets the .\n ", "allOf": [ {} ], "$ref": "#/definitions/Area" }, "Border": { "description": "Gets the border .\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" } } } ] }, "LegendEntry": { "type": "object", "description": " Represents a legend entry in a chart legend.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a legend entry in a chart legend.\n ", "additionalProperties": false, "required": [ "AutoScaleFont", "IsDeleted" ], "properties": { "AutoScaleFont": { "type": "boolean", "description": "True if the text in the object changes font size when the object size changes. \n The default value is True.\n " }, "BackgroundMode": { "type": "string", "description": "Gets and sets the display mode of the background\n " }, "Font": { "description": "Gets a object of the specified ChartFrame object.\n ", "allOf": [ {} ], "$ref": "#/definitions/Font" }, "IsDeleted": { "type": "boolean", "description": "Gets and sets whether the legend entry is deleted.\n " } } } ] }, "Marker": { "type": "object", "description": " Represents the marker in a line chart, scatter chart, or radar chart.\n ", "additionalProperties": false, "properties": { "Border": { "description": "Gets the border.\n ", "allOf": [ {} ], "$ref": "#/definitions/Line" }, "Area": { "description": "Gets the area.\n ", "allOf": [ {} ], "$ref": "#/definitions/Area" }, "MarkerSize": { "type": "integer", "description": "Represents the marker size in unit of points. Applies to line chart, scatter chart, or radar chart.\n ", "format": "int32" }, "MarkerStyle": { "type": "string", "description": "Represents the marker style. Applies to line chart, scatter chart, or radar chart.\n " } } }, "Trendlines": { "type": "object", "description": " Represents a collection of all the objects for the specified data series.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a collection of all the objects for the specified data series.\n ", "additionalProperties": false, "properties": { "TrendlineList": { "type": "array", "description": "This property allows for a list of Trendline objects to be stored under the XmlElement \"TrendLine\".", "items": { "$ref": "#/definitions/Trendline" } } } } ] }, "Trendline": { "type": "object", "description": " Represents a trendline in a chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Line" }, { "type": "object", "description": " Represents a trendline in a chart.\n ", "additionalProperties": false, "properties": { "link": { "description": "The class has a property named \"link\" of type \"Link\" that can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/Link" }, "Backward": { "type": "number", "description": "Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. \n The number of periods must be greater than or equal to zero.\n If the chart type is column ,the number of periods must be between 0 and 0.5\n ", "format": "double" }, "DataLabels": { "description": "Represents the DataLabels object for the specified series.\n ", "allOf": [ {} ], "$ref": "#/definitions/DataLabels" }, "DisplayEquation": { "type": "boolean", "description": "Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.\n " }, "DisplayRSquared": { "type": "boolean", "description": "Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.\n " }, "Forward": { "type": "number", "description": "Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward.\n The number of periods must be greater than or equal to zero.\n ", "format": "double" }, "Intercept": { "type": "number", "description": "Returns or sets the point where the trendline crosses the value axis.\n ", "format": "double" }, "IsNameAuto": { "type": "boolean", "description": "Returns if Microsoft Excel automatically determines the name of the trendline.\n " }, "LegendEntry": { "description": "Gets the legend entry according to this trendline\n ", "allOf": [ {} ], "$ref": "#/definitions/LegendEntry" }, "Name": { "type": "string", "description": "Returns the name of the trendline.\n " }, "Order": { "type": "integer", "description": "Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. \n The order must be between 2 and 6.\n ", "format": "int32" }, "Period": { "type": "integer", "description": "Returns or sets the period for the moving-average trendline.\n ", "format": "int32" }, "Type": { "type": "string", "description": "Returns the trendline type.\n " } } } ] }, "ErrorBar": { "type": "object", "description": " Represents error bar of data series.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Line" }, { "type": "object", "description": " Represents error bar of data series.\n ", "additionalProperties": false, "properties": { "Link": { "description": "A property named \"Link\" of type \"Link\" that can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/Link" }, "Amount": { "type": "number", "description": "Represents amount of error bar.\n The amount must be greater than or equal to zero.\n ", "format": "double" }, "DisplayType": { "type": "string", "description": "Represents error bar display type.\n " }, "MinusValue": { "type": "string", "description": "Represents negative error amount when error bar type is Custom.\n " }, "PlusValue": { "type": "string", "description": "Represents positive error amount when error bar type is Custom.\n " }, "ShowMarkerTTop": { "type": "boolean", "description": "Indicates if formatting error bars with a T-top.\n " }, "Type": { "type": "string", "description": "Represents error bar amount type.\n " } } } ] }, "PlotArea": { "type": "object", "description": " Encapsulates the object that represents the plot area in a chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChartFrame" }, { "type": "object", "description": " Encapsulates the object that represents the plot area in a chart.\n ", "additionalProperties": false, "properties": { "InnerHeight": { "type": "integer", "description": "Gets or sets the height of plot area in units of 1/4000 of the chart area.\n ", "format": "int32" }, "InnerWidth": { "type": "integer", "description": "Gets or sets the width of plot area in units of 1/4000 of the chart area.\n ", "format": "int32" }, "InnerX": { "type": "integer", "description": "Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.\n ", "format": "int32" }, "InnerY": { "type": "integer", "description": "Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.\n ", "format": "int32" } } } ] }, "LegendResponse": { "type": "object", "description": " Represents the Legend Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Legend Response.\n ", "additionalProperties": false, "properties": { "Legend": { "description": "This class has a public property called \"Legend\" of type \"Legend\" which has both a getter and a setter.", "allOf": [ {} ], "$ref": "#/definitions/Legend" } } } ] }, "TitleResponse": { "type": "object", "description": " Represents the Title Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Title Response.\n ", "additionalProperties": false, "properties": { "Title": { "description": "This class has a property called \"Title\" of type \"Title\" with both a getter and a setter.", "allOf": [ {} ], "$ref": "#/definitions/Title" } } } ] }, "AxisResponse": { "type": "object", "description": " Represents the Axis Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Axis Response.\n ", "additionalProperties": false, "properties": { "Axis": { "description": "A property named \"Axis\" of type \"Axis\" with both getter and setter methods is present in the class.", "allOf": [ {} ], "$ref": "#/definitions/Axis" } } } ] }, "ConditionalFormattingsResponse": { "type": "object", "description": " Represents the ConditionalFormattings Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the ConditionalFormattings Response.\n ", "additionalProperties": false, "properties": { "ConditionalFormattings": { "description": "A property named ConditionalFormattings of type ConditionalFormattings is defined with both getter and setter methods in the class.", "allOf": [ {} ], "$ref": "#/definitions/ConditionalFormattings" } } } ] }, "ConditionalFormattings": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "required": [ "Count" ], "properties": { "Count": { "type": "integer", "description": "The property \"Count\" is decorated with [XmlElement(\"count\")] attribute for XML serialization.", "format": "int32" }, "ConditionalFormattingList": { "type": "array", "items": { "$ref": "#/definitions/ConditionalFormatting" } } } } ] }, "ConditionalFormatting": { "type": "object", "description": "I'm here to help! Please provide me with the features that need to be summarized.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "I'm here to help! Please provide me with the features that need to be summarized.", "additionalProperties": false, "properties": { "sqref": { "type": "string", "description": "A public property called \"sqref\" of type string with a getter and a setter is defined in the class." }, "FormatConditions": { "type": "array", "items": { "$ref": "#/definitions/FormatCondition" } } } } ] }, "FormatCondition": { "type": "object", "description": " Represents conditional formatting condition.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents conditional formatting condition.\n ", "additionalProperties": false, "properties": { "Priority": { "type": "integer", "description": "The priority of this conditional formatting rule. This value is used to determine which\n format should be evaluated and rendered. Lower numeric values are higher priority than\n higher numeric values, where '1' is the highest priority.\n ", "format": "int32" }, "Type": { "type": "string", "description": "Gets and sets whether the conditional format Type.\n " }, "StopIfTrue": { "type": "boolean", "description": "True, no rules with lower priority may be applied over this rule, when this rule evaluates to true.\n Only applies for Excel 2007;\n " }, "AboveAverage": { "description": "Get the conditional formatting's \"AboveAverage\" instance.\n The default instance's rule highlights cells that are \n above the average for all values in the range.\n Valid only for type = AboveAverage.\n ", "allOf": [ {} ], "$ref": "#/definitions/AboveAverage" }, "ColorScale": { "description": "Get the conditional formatting's \"ColorScale\" instance.\n The default instance is a \"green-yellow-red\" 3ColorScale .\n Valid only for type = ColorScale.\n ", "allOf": [ {} ], "$ref": "#/definitions/ColorScale" }, "DataBar": { "description": "Get the conditional formatting's \"DataBar\" instance.\n The default instance's color is blue.\n Valid only for type is DataBar.\n ", "allOf": [ {} ], "$ref": "#/definitions/DataBar" }, "Formula1": { "type": "string", "description": "Gets and sets the value or expression associated with conditional formatting.\n " }, "Formula2": { "type": "string", "description": "Gets and sets the value or expression associated with conditional formatting.\n " }, "IconSet": { "description": "Get the conditional formatting's \"IconSet\" instance.\n The default instance's IconSetType is TrafficLights31.\n Valid only for type = IconSet.\n ", "allOf": [ {} ], "$ref": "#/definitions/IconSet" }, "Operator": { "type": "string", "description": "Gets and sets the conditional format operator type.\n " }, "Style": { "description": "Gets or setts style of conditional formatted cell ranges.\n ", "allOf": [ {} ], "$ref": "#/definitions/Style" }, "Text": { "type": "string", "description": "The text value in a \"text contains\" conditional formatting rule. \n Valid only for type = containsText, notContainsText, beginsWith and endsWith.\n The default value is null.\n " }, "TimePeriod": { "type": "string", "description": "The applicable time period in a \"date occurring…\" conditional formatting rule. \n Valid only for type = timePeriod.\n The default value is TimePeriodType.Today.\n " }, "Top10": { "description": "Get the conditional formatting's \"Top10\" instance.\n The default instance's rule highlights cells whose\n values fall in the top 10 bracket.\n Valid only for type is Top10.\n ", "allOf": [ {} ], "$ref": "#/definitions/Top10" } } } ] }, "AboveAverage": { "type": "object", "description": "Describe the AboveAverage conditional formatting rule. This conditional formatting\n rule highlights cells that are above or below the average for all values\n in the range.", "additionalProperties": false, "required": [ "IsAboveAverage", "IsEqualAverage", "StdDev" ], "properties": { "IsAboveAverage": { "type": "boolean", "description": "Get or set the flag indicating whether the rule is an \"above average\" rule. \n 'true' indicates 'above average'.\n Default value is true.\n " }, "IsEqualAverage": { "type": "boolean", "description": "Get or set the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria \n is inclusive of the average itself, or exclusive of that value. \n 'true' indicates to include the average value in the criteria.\n Default value is false.\n " }, "StdDev": { "type": "integer", "description": "Get or set the number of standard deviations to include above or below the average in the\n conditional formatting rule. \n The input value must between 0 and 3 (include 0 and 3). \n Setting this value to 0 means stdDev is not set.\n The default value is 0.\n ", "format": "int32" } } }, "ColorScale": { "type": "object", "description": "Describe the ColorScale conditional formatting rule. This conditional formatting\n rule creates a gradated color scale on the cells.\n ", "additionalProperties": false, "properties": { "MaxCfvo": { "description": "Get or set this ColorScale's max value object.\n Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.\n ", "allOf": [ {} ], "$ref": "#/definitions/ConditionalFormattingValue" }, "MaxColor": { "description": "Get or set the gradient color for the maximum value in the range.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "MidCfvo": { "description": "Get or set this ColorScale's mid value object.\n Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it.\n ", "allOf": [ {} ], "$ref": "#/definitions/ConditionalFormattingValue" }, "MidColor": { "description": "Get or set the gradient color for the middle value in the range.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "MinCfvo": { "description": "Get or set this ColorScale's min value object.\n Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.\n ", "allOf": [ {} ], "$ref": "#/definitions/ConditionalFormattingValue" }, "MinColor": { "description": "Get or set the gradient color for the minimum value in the range.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" } } }, "ConditionalFormattingValue": { "type": "object", "description": " Describes the values of the interpolation points in a gradient scale, dataBar or iconSet.\n ", "additionalProperties": false, "properties": { "IsGTE": { "type": "boolean", "description": "Get or set the Greater Than Or Equal flag. \n Use only for icon sets, determines whether this threshold value uses \n the greater than or equal to operator. \n 'false' indicates 'greater than' is used instead of 'greater than or equal to'.\n Default value is true.\n " }, "Type": { "type": "string", "description": "Get or set the type of this conditional formatting value object.\n Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max \n will auto set \"Value\" to null.\n " }, "Value": { "description": "Get or set the value of this conditional formatting value object.\n It should be used in conjunction with Type.\n " } } }, "DataBar": { "type": "object", "description": "Describe the DataBar conditional formatting rule. This conditional formatting\n rule displays a gradated data bar in the range of cells.", "additionalProperties": false, "properties": { "AxisColor": { "description": "Gets the color of the axis for cells with conditional formatting as data bars.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "AxisPosition": { "type": "string", "description": "Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.\n " }, "BarBorder": { "description": "Gets an object that specifies the border of a data bar.\n ", "allOf": [ {} ], "$ref": "#/definitions/DataBarBorder" }, "BarFillType": { "type": "string", "description": "Gets or sets how a data bar is filled with color.\n " }, "Color": { "description": "Get or set this DataBar's Color.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Direction": { "type": "string", "description": "Gets or sets the direction the databar is displayed.\n " }, "MaxCfvo": { "description": "Get or set this DataBar's max value object.\n Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.\n ", "allOf": [ {} ], "$ref": "#/definitions/ConditionalFormattingValue" }, "MaxLength": { "type": "integer", "description": "Represents the max length of data bar .\n ", "format": "int32" }, "MinCfvo": { "description": "Get or set this DataBar's min value object.\n Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.\n ", "allOf": [ {} ], "$ref": "#/definitions/ConditionalFormattingValue" }, "MinLength": { "type": "integer", "description": "Represents the min length of data bar .\n ", "format": "int32" }, "NegativeBarFormat": { "description": "Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.\n ", "allOf": [ {} ], "$ref": "#/definitions/NegativeBarFormat" }, "ShowValue": { "type": "boolean", "description": "Get or set the flag indicating whether to show the values of the cells on which this data bar is applied.\n Default value is true.\n " } } }, "DataBarBorder": { "type": "object", "description": " Represents the border of the data bars specified by a conditional formatting rule.\n ", "additionalProperties": false, "properties": { "Color": { "description": "Gets or sets the border's color of data bars specified by a conditional formatting rule.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Type": { "type": "string", "description": "Gets or sets the border's type of data bars specified by a conditional formatting rule.\n " } } }, "NegativeBarFormat": { "type": "object", "description": "Represents the color settings of the data bars for negative values that are\n defined by a data bar conditional formating rule.\n ", "additionalProperties": false, "properties": { "BorderColor": { "description": "Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BorderColorType": { "type": "string", "description": "Gets whether to use the same border color as positive data bars.\n " }, "Color": { "description": "Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "ColorType": { "type": "string", "description": "Gets or sets whether to use the same fill color as positive data bars.\n " } } }, "IconSet": { "type": "object", "description": "Describe the IconSet conditional formatting rule. This conditional formatting\n rule applies icons to cells according to their values.", "additionalProperties": false, "properties": { "CfIcons": { "type": "array", "description": "Get the from the collection\n ", "items": { "$ref": "#/definitions/ConditionalFormattingIcon" } }, "Cfvos": { "type": "array", "description": "Get the CFValueObjects instance.\n ", "items": { "$ref": "#/definitions/ConditionalFormattingValue" } }, "IsCustom": { "type": "boolean", "description": "Indicates whether the icon set is custom.\n Default value is false.\n " }, "Reverse": { "type": "boolean", "description": "Get or set the flag indicating whether to reverses the default order of the icons in this icon set.\n Default value is false.\n " }, "ShowValue": { "type": "boolean", "description": "Get or set the flag indicating whether to show the values of the cells on which this icon set is applied.\n Default value is true.\n " }, "IconSetType": { "type": "string", "description": "Get or Set the icon set type to display. Setting the type will auto check\n if the current Cfvos's count is accord with the new type. If not accord,\n old Cfvos will be cleaned and default Cfvos will be added.\n " } } }, "ConditionalFormattingIcon": { "type": "object", "description": " Represents the custom icon of conditional formatting rule.\n ", "additionalProperties": false, "properties": { "ImageData": { "type": "string", "description": "Gets the icon set data.\n " }, "Index": { "type": "integer", "description": "Gets and sets the icon's index in the icon set.\n ", "format": "int32" }, "Type": { "type": "string", "description": "Gets and sets the icon set type.\n " } } }, "Top10": { "type": "object", "description": "Describe the Top10 conditional formatting rule. This conditional formatting\n rule highlights cells whose values fall in the top N or bottom N bracket,\n as specified.", "additionalProperties": false, "properties": { "IsBottom": { "type": "boolean", "description": "Get or set whether a \"top/bottom n\" rule is a \"bottom n\" rule.\n Default value is false.\n " }, "IsPercent": { "type": "boolean", "description": "Get or set whether a \"top/bottom n\" rule is a \"top/bottom n percent\" rule.\n Default value is false.\n " }, "Rank": { "type": "integer", "description": "Get or set the value of \"n\" in a \"top/bottom n\" conditional formatting rule.\n If IsPercent is true, the value must between 0 and 100.\n Otherwise it must between 0 and 1000.\n Default value is 10.\n ", "format": "int32" } } }, "ConditionalFormattingResponse": { "type": "object", "description": " Represents the ConditionalFormatting Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the ConditionalFormatting Response.\n ", "additionalProperties": false, "properties": { "ConditionalFormatting": { "description": "This class has a property named ConditionalFormatting of type ConditionalFormatting that can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/ConditionalFormatting" } } } ] }, "CellsCloudFileInfoResponse": { "type": "object", "description": " Represents the CellsCloudFileInfo Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the CellsCloudFileInfo Response.\n ", "additionalProperties": false, "properties": { "FileInfo": { "description": "A property named `FileInfo` of type `CellsCloudFileInfo` is defined for the class.", "allOf": [ {} ], "$ref": "#/definitions/CellsCloudFileInfo" } } } ] }, "CellsCloudFileInfo": { "type": "object", "description": "Cells Cloud File information description.", "additionalProperties": false, "required": [ "Size" ], "properties": { "Name": { "type": "string", "description": "The file name." }, "Size": { "type": "integer", "description": "The file size.", "format": "int64" }, "Folder": { "type": "string", "description": "The file position." }, "Storage": { "type": "string", "description": "The storage name." } } }, "SaveResponse": { "type": "object", "description": " Represents the Save Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Save Response.\n ", "additionalProperties": false, "properties": { "SaveResult": { "description": "This class property represents a \"SaveResult\" XML element.", "allOf": [ {} ], "$ref": "#/definitions/SaveResult" } } } ] }, "SaveResult": { "type": "object", "description": "Represents save result.", "additionalProperties": false, "properties": { "Documents": { "type": "array", "description": "Represents cells cloud file infomation.", "items": { "$ref": "#/definitions/CellsCloudFileInfo" } } } }, "ConvertWorksheetOptions": { "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "additionalProperties": false, "required": [ "ConvertFormat" ], "properties": { "Name": { "type": "string", "description": "The class has a public property named \"Name\" with a getter and setter method." }, "DataSource": { "$ref": "#/definitions/DataSource" }, "FileInfo": { "$ref": "#/definitions/FileInfo" }, "WorksheetName": { "type": "string" }, "PageSetup": { "$ref": "#/definitions/PageSetup" }, "ImageOrPrintOptions": { "$ref": "#/definitions/ImageOrPrintOptions" }, "ConvertFormat": { "enum": [ "Auto", "CSV", "Csv", "Excel97To2003", "Xlsx", "Xlsm", "Xltx", "Xltm", "Xlam", "TSV", "Tsv", "TabDelimited", "Html", "Pdf", "ODS", "Ods", "SpreadsheetML", "Xlsb", "MHtml", "XPS", "Xps", "Tiff", "TIFF", "Svg", "SVG", "Dif", "Ots", "Xlt", "Xml", "Numbers", "Markdown", "Fods", "FODS", "SXC", "Sxc", "Pptx", "Docx", "Unknown", "Emf", "Jpg", "Png", "Bmp", "Gif", "Json", "SqlScript", "Dbf", "XHtml", "Epub", "Azw3", "Pcl" ] }, "CheckExcelRestriction": { "type": "boolean" }, "Region": { "type": "string" } } } ] }, "DataSource": { "type": "object", "description": "Represents data source.", "additionalProperties": false, "required": [ "DataSourceType" ], "properties": { "DataSourceType": { "description": "Represents data source type.", "enum": [ "InMemoryFiles", "CloudFileSystem", "RequestFiles", "HttpUri" ], "allOf": [ {} ] }, "DataPath": { "type": "string", "description": "Represents data path." } } }, "PageSetup": { "type": "object", "description": "excel print page setting", "additionalProperties": false, "properties": { "BlackAndWhite": { "type": "boolean", "description": "Represents if elements of the document will be printed in black and white.\n " }, "BottomMargin": { "type": "number", "description": "Represents the size of the bottom margin, in unit of centimeters.\n ", "format": "double" }, "CenterHorizontally": { "type": "boolean", "description": "Represent if the sheet is printed centered horizontally.\n " }, "CenterVertically": { "type": "boolean", "description": "Represent if the sheet is printed centered vertically.\n " }, "FirstPageNumber": { "type": "integer", "description": "Represents the first page number that will be used when this sheet is printed.\n ", "format": "int32" }, "FitToPagesTall": { "type": "integer", "description": "Represents the number of pages tall the worksheet will be scaled to when it's printed.\n The default value is 1.\n ", "format": "int32" }, "FitToPagesWide": { "type": "integer", "description": "Represents the number of pages wide the worksheet will be scaled to when it's printed.\n The default value is 1.\n ", "format": "int32" }, "FooterMargin": { "type": "number", "description": "Represents the distance from the bottom of the page to the footer, in unit of centimeters.\n ", "format": "double" }, "HeaderMargin": { "type": "number", "description": "Represents the distance from the top of the page to the header, in unit of centimeters.\n ", "format": "double" }, "IsAutoFirstPageNumber": { "type": "boolean", "description": "Indicates whether the first the page number is automatically assigned.\n " }, "IsHFAlignMargins": { "type": "boolean", "description": "Indicates whether header and footer margins are aligned with the page margins.\n If this property is true, the left header and footer will be aligned with the left margin,\n and the right header and footer will be aligned with the right margin.\n This option is enabled by default.\n " }, "IsHFDiffFirst": { "type": "boolean", "description": "True means that the header/footer of the first page is different with other pages.\n " }, "IsHFDiffOddEven": { "type": "boolean", "description": "True means that the header/footer of the odd pages is different with odd pages.\n " }, "IsHFScaleWithDoc": { "type": "boolean", "description": "Indicates whether header and footer are scaled with document scaling.\n Only applies for Excel 2007.\n " }, "IsPercentScale": { "type": "boolean", "description": "If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled.\n " }, "LeftMargin": { "type": "number", "description": "Represents the size of the left margin, in unit of centimeters.\n ", "format": "double" }, "Order": { "type": "string", "description": "Represents the order that Microsoft Excel uses to number pages when printing a large worksheet.\n " }, "Orientation": { "type": "string", "description": "Represents page print orientation.\n " }, "PaperSize": { "type": "string", "description": "Represents the size of the paper.\n " }, "PrintArea": { "type": "string", "description": "Represents the range to be printed.\n " }, "PrintComments": { "type": "string", "description": "Represents the way comments are printed with the sheet.\n " }, "PrintCopies": { "type": "integer", "description": "Get and sets number of copies to print.\n ", "format": "int32" }, "PrintDraft": { "type": "boolean", "description": "Represents if the sheet will be printed without graphics.\n " }, "PrintErrors": { "type": "string", "description": "Specifies the type of print error displayed.\n " }, "PrintGridlines": { "type": "boolean", "description": "Represents if cell gridlines are printed on the page.\n " }, "PrintHeadings": { "type": "boolean", "description": "Represents if row and column headings are printed with this page.\n " }, "PrintQuality": { "type": "integer", "description": "Represents the print quality.\n ", "format": "int32" }, "PrintTitleColumns": { "type": "string", "description": "Represents the columns that contain the cells to be repeated on the left side of each page.\n " }, "PrintTitleRows": { "type": "string", "description": "Represents the rows that contain the cells to be repeated at the top of each page.\n " }, "RightMargin": { "type": "number", "description": "Represents the size of the right margin, in unit of centimeters.\n ", "format": "double" }, "TopMargin": { "type": "number", "description": "Represents the size of the top margin, in unit of centimeters.\n ", "format": "double" }, "Zoom": { "type": "integer", "description": "Represents the scaling factor in percent. It should be between 10 and 400.\n ", "format": "int32" }, "Header": { "type": "array", "description": "Represents the page header.", "items": { "$ref": "#/definitions/PageSection" } }, "Footer": { "type": "array", "description": "Represents the page footor.", "items": { "$ref": "#/definitions/PageSection" } } } }, "PageSection": { "type": "object", "description": "Class summary: Includes interactive discussions, group projects, guest speakers, and practical applications of course material.", "additionalProperties": false, "required": [ "Section" ], "properties": { "Section": { "type": "integer", "description": "0,1,2 left , middle ,right", "format": "int32" }, "Context": { "type": "string", "description": "page context script\n " }, "Picture": { "type": "string", "description": "A property named \"Picture\" with both getter and setter methods of type string is defined." }, "FisrtPageContext": { "type": "string", "description": "fisrt page context script" }, "EvenPageContext": { "type": "string", "description": "Even page context script" } } }, "ImageOrPrintOptions": { "type": "object", "description": " Allows to specify options when rendering worksheet to images, printing worksheet or rendering chart to image.\n ", "additionalProperties": false, "properties": { "TextCrossType": { "type": "string", "description": "TextCrossType" }, "GridlineType": { "type": "string", "description": "GridlineType" }, "OutputBlankPageWhenNothingToPrint": { "type": "boolean", "description": "Indicates whether to output a blank page when there is nothing to print." }, "CheckWorkbookDefaultFont": { "type": "boolean" }, "DefaultFont": { "type": "string" }, "IsOptimized": { "type": "boolean" }, "PageCount": { "type": "integer", "format": "int32" }, "PageIndex": { "type": "integer", "format": "int32" }, "IsFontSubstitutionCharGranularity": { "type": "boolean" }, "Transparent": { "type": "boolean" }, "OnlyArea": { "type": "boolean" }, "SVGFitToViewPort": { "type": "boolean" }, "EmbededImageNameInSvg": { "type": "string" }, "AllColumnsInOnePagePerSheet": { "type": "boolean" }, "PrintWithStatusDialog": { "type": "boolean" }, "HorizontalResolution": { "type": "integer", "format": "int32" }, "VerticalResolution": { "type": "integer", "format": "int32" }, "DefaultEditLanguage": { "type": "string", "description": "DefaultEditLanguage" }, "TiffColorDepth": { "type": "string", "description": "ColorDepth" }, "TiffCompression": { "type": "string", "description": "TiffCompression" }, "PrintingPage": { "type": "string", "description": "PrintingPageType" }, "Quality": { "type": "integer", "format": "int32" }, "ImageType": { "type": "string", "description": "ImageType" }, "OnePagePerSheet": { "type": "boolean" }, "TiffBinarizationMethod": { "type": "string", "description": "ImageBinarizationMethod" } } }, "BaseOperateOptions": { "type": "object", "discriminator": "Type", "x-abstract": true, "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "The property \"Name\" is a virtual string type with a public access modifier and a default value of an empty string." } } }, "ConvertWorkbookOptions": { "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "additionalProperties": false, "required": [ "ConvertFormat" ], "properties": { "Name": { "type": "string", "description": "The class has a public property named \"Name\" with a getter and setter method." }, "DataSource": { "$ref": "#/definitions/DataSource" }, "FileInfo": { "$ref": "#/definitions/FileInfo" }, "PageSetup": { "$ref": "#/definitions/PageSetup" }, "SaveOptions": { "$ref": "#/definitions/SaveOptions" }, "ConvertFormat": { "enum": [ "Auto", "CSV", "Csv", "Excel97To2003", "Xlsx", "Xlsm", "Xltx", "Xltm", "Xlam", "TSV", "Tsv", "TabDelimited", "Html", "Pdf", "ODS", "Ods", "SpreadsheetML", "Xlsb", "MHtml", "XPS", "Xps", "Tiff", "TIFF", "Svg", "SVG", "Dif", "Ots", "Xlt", "Xml", "Numbers", "Markdown", "Fods", "FODS", "SXC", "Sxc", "Pptx", "Docx", "Unknown", "Emf", "Jpg", "Png", "Bmp", "Gif", "Json", "SqlScript", "Dbf", "XHtml", "Epub", "Azw3", "Pcl" ] }, "CheckExcelRestriction": { "type": "boolean" } } } ] }, "CheckExternalReferenceOptions": { "type": "object", "additionalProperties": false, "properties": { "DataSource": { "$ref": "#/definitions/DataSource" }, "FileInfo": { "$ref": "#/definitions/FileInfo" }, "Worksheet": { "type": "string" }, "Ranged_Table": { "type": "string" }, "ChartIndex": { "type": "integer", "format": "int32" } } }, "CheckFormulaErrorOptions": { "type": "object", "additionalProperties": false, "properties": { "DataSource": { "$ref": "#/definitions/DataSource" }, "FileInfo": { "$ref": "#/definitions/FileInfo" }, "SheetName": { "type": "string" }, "ChartIndex": { "type": "integer", "format": "int32" }, "Names": { "type": "array", "items": { "type": "string" } } } }, "FilesResult": { "type": "object", "description": "Class features: Weekly lectures, group projects, midterm and final exams, and participation in class discussions.", "additionalProperties": false, "properties": { "Files": { "type": "array", "description": "A property named **Files** of type **IList FileInfo ** containing a collection of file information objects.", "items": { "$ref": "#/definitions/FileInfo" } } } }, "ImportJsonRequest": { "type": "object", "description": "Indicates import xml data request", "additionalProperties": false, "properties": { "JsonFileSource": { "description": "Json file source", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "ImportPosition": { "description": "Import position description.", "allOf": [ {} ], "$ref": "#/definitions/ImportPosition" }, "JsonContent": { "type": "string", "description": "Base64String default is null" } } }, "ImportPosition": { "type": "object", "description": "I can help with that. Just provide me with the features you'd like me to summarize.", "additionalProperties": false, "required": [ "RowIndex", "ColumnIndex" ], "properties": { "SheetName": { "type": "string", "description": "\"Property SheetName of type string with a public get and set accessor.\"" }, "RowIndex": { "type": "integer", "format": "int32" }, "ColumnIndex": { "type": "integer", "format": "int32" } } }, "ImportXMLRequest": { "type": "object", "description": "Indicates import xml data request", "additionalProperties": false, "properties": { "XMLFileSource": { "description": "XML file source", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "ImportPosition": { "description": "Import position description.", "allOf": [ {} ], "$ref": "#/definitions/ImportPosition" }, "XMLContent": { "type": "string", "description": "Base64String default is null" } } }, "ImportOption": { "type": "object", "description": "Class Summary: This class covers the features of artificial intelligence, machine learning, deep learning, and natural language processing.", "additionalProperties": false, "required": [ "IsInsert" ], "properties": { "DestinationWorksheet": { "type": "string", "description": "Destination worksheet name. " }, "IsInsert": { "type": "boolean", "description": "A boolean property `IsInsert` that can be both read and written." }, "ImportDataType": { "type": "string" }, "DataSource": { "$ref": "#/definitions/DataSource" }, "Source": { "$ref": "#/definitions/FileSource" } } }, "FileSource": { "type": "object", "description": "I'm sorry, I just realized you didn't provide any features for me to summarize. Please provide the features you'd like me to summarize for the class.", "additionalProperties": false, "required": [ "FileSourceType" ], "properties": { "FileSourceType": { "description": "A property named FileSourceType of type FileSourceType that can be accessed and modified.", "enum": [ "InMemoryFiles", "CloudFileSystem", "RequestFiles", "HttpUri" ], "allOf": [ {} ] }, "FilePath": { "type": "string" } } }, "DataCleansing": { "type": "object", "description": "Represents data cleansing.", "additionalProperties": false, "required": [ "NeedFillData" ], "properties": { "Ranges": { "type": "array", "description": "A property named \"Ranges\" of type IList Range with a default value of an empty List of Range objects.", "items": { "$ref": "#/definitions/Range" } }, "NeedFillData": { "type": "boolean", "description": "Represents whether the data needs to be populated." }, "DataFill": { "description": "Represents data fill.", "allOf": [ {} ], "$ref": "#/definitions/DataFill" } } }, "Range": { "type": "object", "description": " Encapsulates the object that represents a range of cells within a spreadsheet.\n ", "additionalProperties": false, "required": [ "ColumnCount", "FirstColumn", "FirstRow", "RowCount" ], "properties": { "ColumnCount": { "type": "integer", "description": "Gets the count of columns in the range.\n ", "format": "int32" }, "ColumnWidth": { "type": "number", "description": "Sets or gets the column width of this range\n ", "format": "double" }, "FirstColumn": { "type": "integer", "description": "Gets the index of the first column of the range.\n ", "format": "int32" }, "FirstRow": { "type": "integer", "description": "Gets the index of the first row of the range.\n ", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the range.\n " }, "RefersTo": { "type": "string", "description": "Gets the range's refers to.\n " }, "RowCount": { "type": "integer", "description": "Gets the count of rows in the range.\n ", "format": "int32" }, "RowHeight": { "type": "number", "description": "Sets or gets the height of rows in this range\n ", "format": "double" }, "Worksheet": { "type": "string", "description": "Gets the object which contains this range.\n " } } }, "DataFill": { "type": "object", "description": "Represents data filling.", "additionalProperties": false, "properties": { "Ranges": { "type": "array", "description": "Represents range of data filling.", "items": { "$ref": "#/definitions/Range" } }, "DataFillDefaultValue": { "description": "Represents that the data column is populated with the default value.", "allOf": [ {} ], "$ref": "#/definitions/DataFillValue" }, "DataColumnFillValueList": { "type": "array", "description": "Represents that the data column is populated with the specified value.", "items": { "$ref": "#/definitions/DataColumnFillValue" } } } }, "DataFillValue": { "type": "object", "description": "Represents that the data is populated with the specified value.", "additionalProperties": false, "properties": { "DefaultBoolean": { "type": "boolean", "description": "Represents default bool value. " }, "DefaultString": { "type": "string", "description": "Represents default string value. \n " }, "DefaultNumber": { "type": "integer", "description": "Represents default number value. \n ", "format": "int32" }, "DefaultDouble": { "type": "number", "description": "Represents default double value. \n ", "format": "double" }, "DefaultDate": { "type": "string", "description": "Represents default date value. \n " } } }, "DataColumnFillValue": { "type": "object", "description": "Represents that the data column is populated with the specified value.", "additionalProperties": false, "required": [ "ColumnIndex" ], "properties": { "ColumnIndex": { "type": "integer", "description": "Represents specified column index.", "format": "int32" }, "DataFillValue": { "description": "Represents specified data fill value.", "allOf": [ {} ], "$ref": "#/definitions/DataFillValue" } } }, "DataCleansingRequest": { "type": "object", "description": "A data cleansing request for an Spreadsheet file.", "additionalProperties": false, "required": [ "CheckExcelRestriction" ], "properties": { "File": { "description": "Spreadsheet files that require data cleaning. ", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "CheckExcelRestriction": { "type": "boolean", "description": "Whether check restriction of Spreadsheet file when user modify cells related objects." }, "Region": { "type": "string", "description": "The regional settings for workbook." }, "OutFileFormat": { "type": "string", "description": "finish to data cleansing, outfile`s file format." }, "DataCleansing": { "description": "Data cleansing content", "allOf": [ {} ], "$ref": "#/definitions/DataCleansing" } } }, "DeduplicationRegion": { "type": "object", "description": "Represents data deduplication region.", "additionalProperties": false, "properties": { "Ranges": { "type": "array", "description": "Represents data range.", "items": { "$ref": "#/definitions/Range" } }, "WorksheetNameList": { "type": "array", "description": "Represents worksheet name list.", "items": { "type": "string" } } } }, "DataDeduplicationRequest": { "type": "object", "additionalProperties": false, "required": [ "CheckExcelRestriction" ], "properties": { "File": { "description": "Spreadsheet files that require data fulling. ", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "DeduplicationRegion": { "description": "This class has a property named \"DeduplicationRegion\" of type \"DeduplicationRegion\" with a default value of a new instance of the \"DeduplicationRegion\" class.", "allOf": [ {} ], "$ref": "#/definitions/DeduplicationRegion" }, "OutFileFormat": { "type": "string", "description": "finish to data cleansing, outfile`s file format." }, "CheckExcelRestriction": { "type": "boolean", "description": "Whether check restriction of Spreadsheet file when user modify cells related objects." }, "Region": { "type": "string", "description": "The regional settings for workbook." } } }, "DataFillRequest": { "type": "object", "description": "I'm happy to help! Please provide the features you would like me to summarize.", "additionalProperties": false, "required": [ "CheckExcelRestriction" ], "properties": { "File": { "description": "Spreadsheet files that require data fulling. ", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "OutFileFormat": { "type": "string", "description": "finish to data cleansing, outfile`s file format." }, "CheckExcelRestriction": { "type": "boolean", "description": "Whether check restriction of Spreadsheet file when user modify cells related objects." }, "Region": { "type": "string", "description": "The regional settings for workbook." }, "DataFill": { "description": "Fill data default value.", "allOf": [ {} ], "$ref": "#/definitions/DataFill" } } }, "DeleteIncompleteRowsRequest": { "type": "object", "description": "I'm here to help! Could you please provide the features you would like me to summarize?", "additionalProperties": false, "required": [ "CheckExcelRestriction" ], "properties": { "File": { "description": "Spreadsheet files that require data fulling. ", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "OutFileFormat": { "type": "string", "description": "finish to data cleansing, outfile`s file format." }, "CheckExcelRestriction": { "type": "boolean", "description": "Whether check restriction of Spreadsheet file when user modify cells related objects." }, "Region": { "type": "string", "description": "The regional settings for workbook." }, "Ranges": { "type": "array", "description": "A property named \"Ranges\" of type IList of Range, with a default value of an empty List of Range.", "items": { "$ref": "#/definitions/Range" } } } }, "DataTransformationRequest": { "type": "object", "description": "Data Transformation Request", "additionalProperties": false, "properties": { "Queries": { "type": "array", "description": "Indicates data query list. ", "items": { "$ref": "#/definitions/DataQuery" } }, "FileInfo": { "description": "Indicates the source of the mount data.", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "DataSource": { "description": "Indicates the source of the mount data.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "LoadData": { "description": "Indicates load data.", "allOf": [ {} ], "$ref": "#/definitions/LoadData" }, "AppliedSteps": { "type": "array", "description": "Indicates applied step list. ", "items": { "$ref": "#/definitions/AppliedStep" } }, "Region": { "type": "string", "description": "This class has a property named \"Region\" of type string with both a getter and a setter." }, "OutFormat": { "type": "string", "description": "Indicates output format " } } }, "DataQuery": { "type": "object", "description": "Data query.", "additionalProperties": false, "required": [ "DataSourceDataType" ], "properties": { "Name": { "type": "string", "description": "Define a name for data query. Unique identification." }, "DataSourceDataType": { "description": "The specific data object type. When the value is File, DataItem is invalid.", "enum": [ "File", "Worksheet", "ListObject", "Range" ], "allOf": [ {} ] }, "DataSource": { "description": "Indicates the source of the mount data.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "When data souce is request files, FileInfo store the contents of the file.", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "DataItem": { "description": "The specific data object type and name.", "allOf": [ {} ], "$ref": "#/definitions/DataItem" } } }, "DataItem": { "type": "object", "description": "Represents data item.", "additionalProperties": false, "required": [ "DataItemType" ], "properties": { "DataItemType": { "description": "Represents data item type.\n ", "enum": [ "WorkSheet", "Table", "Range" ], "allOf": [ {} ] }, "Value": { "type": "string", "description": "Represents data item value.\n " } } }, "LoadData": { "type": "object", "description": "Loading data information.", "additionalProperties": false, "properties": { "LoadTo": { "description": "Indicates begin position for loading data. ", "allOf": [ {} ], "$ref": "#/definitions/LoadTo" }, "DataQuery": { "description": "Indicates data query for data loading. ", "allOf": [ {} ], "$ref": "#/definitions/DataQuery" } } }, "LoadTo": { "type": "object", "description": "A description of the location to which the data is mounted.", "additionalProperties": false, "required": [ "beginRowIndex", "beginColumnIndex" ], "properties": { "Worksheet": { "type": "string", "description": "The worksheet name." }, "beginRowIndex": { "type": "integer", "description": "The begin row index of worksheet.", "format": "int32" }, "beginColumnIndex": { "type": "integer", "description": "The begin column index of worksheet.", "format": "int32" } } }, "AppliedStep": { "type": "object", "description": "Each data manipulation step that is performed when you get the query data.", "additionalProperties": false, "properties": { "StepName": { "type": "string", "description": "Data manipulation step name." }, "AppliedOperate": { "description": "Data manipulation name.", "allOf": [ {} ], "$ref": "#/definitions/AppliedOperate" } } }, "AppliedOperate": { "type": "object", "description": "A data operation that is used to obtain a query of data.", "x-abstract": true, "additionalProperties": false, "required": [ "AppliedOperateType" ], "properties": { "AppliedOperateType": { "description": "Property summary: Utilizes a custom JSON converter to serialize and deserialize an enum property.", "enum": [ "PivotColumn", "UnpivotColumn", "MergeQueris" ], "allOf": [ {} ] } } }, "FilesUploadResult": { "type": "object", "description": "File upload result", "additionalProperties": false, "properties": { "Uploaded": { "type": "array", "description": "List of uploaded file names", "items": { "type": "string" } }, "Errors": { "type": "array", "description": "List of errors.", "items": { "$ref": "#/definitions/Error" } } } }, "Error": { "type": "object", "description": "Error", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code\n " }, "Message": { "type": "string", "description": "Message\n " }, "Description": { "type": "string", "description": "Description\n " }, "InnerError": { "description": "Inner Error\n ", "allOf": [ {} ], "$ref": "#/definitions/ErrorDetails" } } }, "ErrorDetails": { "type": "object", "description": "The error details", "additionalProperties": false, "required": [ "Date" ], "properties": { "RequestId": { "type": "string", "description": "The request id" }, "Date": { "type": "string", "description": "Date", "format": "date-time" } } }, "FilesList": { "type": "object", "description": "Files list", "additionalProperties": false, "properties": { "Value": { "type": "array", "description": "Files and folders contained by folder StorageFile.", "items": { "$ref": "#/definitions/StorageFile" } } } }, "StorageFile": { "type": "object", "discriminator": "Type", "description": "File or folder information", "additionalProperties": false, "required": [ "IsFolder", "Size" ], "properties": { "Name": { "type": "string", "description": "File or folder name." }, "IsFolder": { "type": "boolean", "description": "True if it is a folder." }, "ModifiedDate": { "type": "string", "description": "File or folder last modified DateTime.", "format": "date-time" }, "Size": { "type": "integer", "description": "File or folder size.", "format": "int64" }, "Path": { "type": "string", "description": "File or folder path." } } }, "HyperlinksResponse": { "type": "object", "description": " Represents the Hyperlinks Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Hyperlinks Response.\n ", "additionalProperties": false, "properties": { "Hyperlinks": { "description": "This class has a property named \"Hyperlinks\" of type Hyperlinks which can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/Hyperlinks" } } } ] }, "Hyperlinks": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "required": [ "Count" ], "properties": { "Count": { "type": "integer", "description": "Property Summary: An integer property named Count with an XML element name \"count.\"", "format": "int32" }, "HyperlinkList": { "type": "array", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "HyperlinkResponse": { "type": "object", "description": " Represents the Hyperlink Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Hyperlink Response.\n ", "additionalProperties": false, "properties": { "Hyperlink": { "description": "A public property named \"Hyperlink\" of type Hyperlink with both getter and setter methods.", "allOf": [ {} ], "$ref": "#/definitions/Hyperlink" } } } ] }, "Hyperlink": { "type": "object", "description": " Encapsulates the object that represents a hyperlink.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates the object that represents a hyperlink.\n ", "additionalProperties": false, "properties": { "Address": { "type": "string", "description": "Represents the address of a hyperlink.\n " }, "Area": { "description": "Gets the range of hyperlink.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellArea" }, "ScreenTip": { "type": "string", "description": "Returns or sets the ScreenTip text for the specified hyperlink.\n " }, "TextToDisplay": { "type": "string", "description": "Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.\n " }, "LinkType": { "type": "string", "description": "Gets the link type.\n " } } } ] }, "CellArea": { "type": "object", "description": " Represent an area of cells.\n ", "additionalProperties": false, "required": [ "EndColumn", "EndRow", "StartColumn", "StartRow" ], "properties": { "EndColumn": { "type": "integer", "description": "The end column index.", "format": "int32" }, "EndRow": { "type": "integer", "description": "The end row index.", "format": "int32" }, "StartColumn": { "type": "integer", "description": "The start column index.", "format": "int32" }, "StartRow": { "type": "integer", "description": "The start row index.", "format": "int32" } } }, "TextItem": { "type": "object", "description": "Represents text item.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents text item.", "additionalProperties": false, "properties": { "Text": { "type": "string", "description": "Represents text content." } } } ] }, "CellsDocumentProperty": { "type": "object", "description": "Cells document property.", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Returns the name of the property.\n " }, "Value": { "type": "string", "description": "Gets or sets the value of the property." }, "IsLinkedToContent": { "type": "string", "description": "Indicates whether this property is linked to content" }, "Source": { "type": "string", "description": "The linked content source." }, "Type": { "type": "string", "description": "Gets the data type of the property.\n " }, "IsGeneratedName": { "type": "string", "description": "Returns true if this property does not have a name in the OLE2 storage and a \n unique name was generated only for the public API.\n " } } }, "ListObjectsResponse": { "type": "object", "description": " Represents the ListObjects Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the ListObjects Response.\n ", "additionalProperties": false, "properties": { "ListObjects": { "description": "A property named \"ListObjects\" of type \"Tables.ListObjects\" that can be both accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/ListObjects" } } } ] }, "ListObjects": { "type": "object", "description": " Represents a collection of objects in the worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a collection of objects in the worksheet.\n ", "additionalProperties": false, "properties": { "ListObjectList": { "type": "array", "description": "A property named ListObjectList that is a list of LinkElement objects.", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "ListObject": { "type": "object", "description": " Represents a list object on a worksheet. The ListObject object is a member of the ListObjects collection. The ListObjects collection contains all the list objects on a worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a list object on a worksheet. The ListObject object is a member of the ListObjects collection. The ListObjects collection contains all the list objects on a worksheet.\n ", "additionalProperties": false, "properties": { "AutoFilter": { "description": "Gets auto filter.\n ", "allOf": [ {} ], "$ref": "#/definitions/AutoFilter" }, "DisplayName": { "type": "string", "description": "Gets and sets the display name.\n " }, "StartColumn": { "type": "integer", "description": "Gets the start column of the range.\n ", "format": "int32" }, "StartRow": { "type": "integer", "description": "Gets the start row of the range.\n ", "format": "int32" }, "EndColumn": { "type": "integer", "description": "Gets the end column of the range.\n ", "format": "int32" }, "EndRow": { "type": "integer", "description": "Gets the end row of the range.\n ", "format": "int32" }, "ListColumns": { "type": "array", "description": "Gets ListColumns of the ListObject.\n ", "items": { "$ref": "#/definitions/ListColumn" } }, "ShowHeaderRow": { "type": "boolean", "description": "Gets and sets whether this ListObject show header row.\n " }, "ShowTableStyleColumnStripes": { "type": "boolean", "description": "Indicates whether column stripe formatting is applied.\n " }, "ShowTableStyleFirstColumn": { "type": "boolean", "description": "Indicates whether the first column in the table should have the style applied.\n " }, "ShowTableStyleLastColumn": { "type": "boolean", "description": "Indicates whether the last column in the table should have the style applied.\n " }, "ShowTableStyleRowStripes": { "type": "boolean", "description": "Indicates whether row stripe formatting is applied.\n " }, "ShowTotals": { "type": "boolean", "description": "Gets and sets whether this ListObject show total row.\n " }, "TableStyleName": { "type": "string", "description": "Gets and sets the table style name.\n " }, "TableStyleType": { "type": "string", "description": "Gets and the built-in table style.\n " }, "DataRange": { "description": "Gets the data range of the ListObject.\n ", "allOf": [ {} ], "$ref": "#/definitions/Range" }, "DataSourceType": { "type": "string", "description": "Gets the data source type of the table.\n " }, "Comment": { "type": "string", "description": "Gets and sets the comment of the table.\n " }, "XmlMap": { "description": "Gets an used for this list.\n ", "allOf": [ {} ], "$ref": "#/definitions/XmlMap" }, "AlternativeText": { "type": "string", "description": "Gets and sets the alternative text.\n " }, "AlternativeDescription": { "type": "string", "description": "Gets and sets the alternative description.\n " } } } ] }, "ListColumn": { "type": "object", "description": " Represents a column in a Table.\n ", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Gets and sets the name of the column.\n " }, "Range": { "description": "Gets the range of this list column.\n ", "allOf": [ {} ], "$ref": "#/definitions/Range" }, "TotalsCalculation": { "type": "string", "description": "Gets and sets the type of calculation in the Totals row of the list column.\n " }, "Formula": { "type": "string", "description": "Gets and sets the formula of the list column.\n " }, "TotalsRowLabel": { "type": "string", "description": "Gets and sets the display labels of total row.\n " } } }, "XmlMap": { "type": "object", "description": "Represents Xml map information.\n ", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Returns or sets the name of the object.\n " }, "RootElementName": { "type": "string", "description": "Gets root element name.\n " }, "DataBinding": { "description": "Gets an of this map.\n ", "allOf": [ {} ], "$ref": "#/definitions/XmlDataBinding" } } }, "XmlDataBinding": { "type": "object", "description": "Represents Xml Data Binding information.\n ", "additionalProperties": false, "properties": { "Url": { "type": "string", "description": "Gets source url of this data binding.\n " } } }, "CreatePivotTableRequest": { "type": "object", "description": "Indicates create pivot table request", "additionalProperties": false, "required": [ "UseSameSource" ], "properties": { "Name": { "type": "string", "description": "Pivot table name" }, "SourceData": { "type": "string", "description": "The data for the new PivotTable cache." }, "DestCellName": { "type": "string", "description": "The cell in the upper-left corner of the PivotTable report's destination range." }, "UseSameSource": { "type": "boolean", "description": "Indicates whether using same data source when another existing pivot table has used this data source.If the property is true, it will save memory." }, "PivotFieldRows": { "type": "array", "description": "Represents row fields in a PivotTable report.", "items": { "type": "integer", "format": "int32" } }, "PivotFieldColumns": { "type": "array", "description": "Represents column fields in a PivotTable report.", "items": { "type": "integer", "format": "int32" } }, "PivotFieldData": { "type": "array", "description": "Represents data fields in a PivotTable report.", "items": { "type": "integer", "format": "int32" } } } }, "TableTotalRequest": { "type": "object", "description": "Indicates table total request", "additionalProperties": false, "required": [ "ListColumnIndex" ], "properties": { "ListColumnIndex": { "type": "integer", "description": "Indicates list column index.", "format": "int32" }, "TotalsCalculation": { "type": "string", "description": "Indicates totals calculation." }, "CustomFormula": { "type": "string", "description": "Indicates custom formula." } } }, "OleObjectsResponse": { "type": "object", "description": " Represents the OleObjects Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the OleObjects Response.\n ", "additionalProperties": false, "properties": { "OleObjects": { "description": "Property `OleObjects` of type `OleObjects` that can be accessed and modified publicly within the class.", "allOf": [ {} ], "$ref": "#/definitions/OleObjects" } } } ] }, "OleObjects": { "type": "object", "description": " Represents embedded OLE objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents embedded OLE objects.\n ", "additionalProperties": false, "properties": { "OleObjectList": { "type": "array", "description": "Property Summary: Contains a list of elements identified as \"oleobject\" within XML data.", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "OleObject": { "type": "object", "description": " Represents an OleObject in a worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Shape" }, { "type": "object", "description": " Represents an OleObject in a worksheet.\n ", "additionalProperties": false, "properties": { "DisplayAsIcon": { "type": "boolean", "description": "True if the specified object is displayed as an icon \n and the image will not be auto changed.\n " }, "FileFormatType": { "type": "string", "description": "Gets and sets the file type of the embedded ole object data\n " }, "ImageSourceFullName": { "type": "string", "description": "Gets or sets the path and name of the source file for the linked image.\n " }, "IsAutoSize": { "type": "boolean", "description": "True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content\n when the ole object is activated.\n " }, "IsLink": { "type": "boolean", "description": "Returns true if the OleObject links to the file.\n " }, "ProgID": { "type": "string", "description": "Gets or sets the ProgID of the OLE object.\n " }, "SourceFullName": { "type": "string", "description": "Returns the source full name of the source file for the linked OLE object.\n " } } } ] }, "Shape": { "type": "object", "discriminator": "Type", "description": " Represents the msodrawing object.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents the msodrawing object.\n ", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Gets and sets the name of the shape.\n " }, "MsoDrawingType": { "type": "string", "description": "Gets mso drawing type.\n " }, "AutoShapeType": { "type": "string", "description": "Gets and sets the auto shape type.\n " }, "Placement": { "type": "string", "description": "Represents the way the drawing object is attached to the cells below it.\n The property controls the placement of an object on a worksheet.\n " }, "UpperLeftRow": { "type": "integer", "description": "Represents upper left corner row index.\n ", "format": "int32" }, "Top": { "type": "integer", "description": "Represents the vertical offset of shape from its top row, in unit of pixels.\n ", "format": "int32" }, "UpperLeftColumn": { "type": "integer", "description": "Represents upper left corner column index.\n ", "format": "int32" }, "Left": { "type": "integer", "description": "Represents the horizontal offset of shape from its left column, in unit of pixels.\n ", "format": "int32" }, "LowerRightRow": { "type": "integer", "description": "Represents lower right corner row index.\n ", "format": "int32" }, "Bottom": { "type": "integer", "description": "Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.\n ", "format": "int32" }, "LowerRightColumn": { "type": "integer", "description": "Represents lower right corner column index.\n ", "format": "int32" }, "Right": { "type": "integer", "description": "Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.\n ", "format": "int32" }, "Width": { "type": "integer", "description": "Represents the width of shape, in unit of pixels.\n ", "format": "int32" }, "Height": { "type": "integer", "description": "Represents the height of shape, in unit of pixel.\n ", "format": "int32" }, "X": { "type": "integer", "description": "Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.\n ", "format": "int32" }, "Y": { "type": "integer", "description": "Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.\n ", "format": "int32" }, "RotationAngle": { "type": "number", "description": "Gets and sets the rotation of the shape.\n ", "format": "double" }, "HtmlText": { "type": "string", "description": "Gets and sets the html string which contains data and some formats in this textbox.\n " }, "Text": { "type": "string", "description": "Represents the string in this TextBox object.\n " }, "AlternativeText": { "type": "string", "description": "Returns or sets the descriptive (alternative) text string of the object.\n " }, "TextHorizontalAlignment": { "type": "string", "description": "Gets and sets the text horizontal alignment type of the shape.\n " }, "TextHorizontalOverflow": { "type": "string", "description": "Gets and sets the text horizontal overflow type of the shape which contains text.\n " }, "TextOrientationType": { "type": "string", "description": "Gets and sets the text orientation type of the shape.\n " }, "TextVerticalAlignment": { "type": "string", "description": "Gets and sets the text vertical alignment type of the shape.\n " }, "TextVerticalOverflow": { "type": "string", "description": "Gets and sets the text vertical overflow type of the shape which contains text.\n " }, "IsGroup": { "type": "boolean", "description": "Indicates whether the shape is a group.\n " }, "IsHidden": { "type": "boolean", "description": "Indicates whether the object is visible.\n " }, "IsLockAspectRatio": { "type": "boolean", "description": "True means that don't allow changes in aspect ratio.\n " }, "IsLocked": { "type": "boolean", "description": "True if the object is locked, False if the object can be modified when the sheet is protected.\n " }, "IsPrintable": { "type": "boolean", "description": "True if the object is printable\n " }, "IsTextWrapped": { "type": "boolean", "description": "Gets and sets the text wrapped type of the shape which contains text.\n " }, "IsWordArt": { "type": "boolean", "description": "Indicates whether this shape is a word art.\n " }, "LinkedCell": { "type": "string", "description": "Gets or sets the worksheet range linked to the control's value.\n " }, "ZOrderPosition": { "type": "integer", "description": "Returns the position of a shape in the z-order.\n ", "format": "int32" }, "Font": { "description": "Represents the font of shape.\n ", "allOf": [ {} ], "$ref": "#/definitions/Font" }, "Hyperlink": { "type": "string", "description": "Gets the hyperlink of the shape.\n " } } } ] }, "VerticalPageBreaksResponse": { "type": "object", "description": " Represents the VerticalPageBreaks Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the VerticalPageBreaks Response.\n ", "additionalProperties": false, "properties": { "VerticalPageBreaks": { "description": "This class has a property named VerticalPageBreaks of type VerticalPageBreaks that can be both read from and written to.", "allOf": [ {} ], "$ref": "#/definitions/VerticalPageBreaks" } } } ] }, "VerticalPageBreaks": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "properties": { "VerticalPageBreakList": { "type": "array", "items": { "$ref": "#/definitions/VerticalPageBreak" } } } } ] }, "VerticalPageBreak": { "type": "object", "description": " Encapsulates the object that represents a vertical page break.\n ", "additionalProperties": false, "required": [ "Column", "EndRow", "StartRow" ], "properties": { "Column": { "type": "integer", "description": "Gets the column index of the vertical page break.\n ", "format": "int32" }, "EndRow": { "type": "integer", "description": "Gets the end row index of the vertical page break.\n ", "format": "int32" }, "StartRow": { "type": "integer", "description": "Gets the start row index of the vertical page break.\n ", "format": "int32" } } }, "HorizontalPageBreaksResponse": { "type": "object", "description": " Represents the HorizontalPageBreaks Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the HorizontalPageBreaks Response.\n ", "additionalProperties": false, "properties": { "HorizontalPageBreaks": { "description": "The property \"HorizontalPageBreaks\" allows getting and setting horizontal page breaks for the class.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalPageBreaks" } } } ] }, "HorizontalPageBreaks": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "properties": { "HorizontalPageBreakList": { "type": "array", "items": { "$ref": "#/definitions/HorizontalPageBreak" } } } } ] }, "HorizontalPageBreak": { "type": "object", "description": " Encapsulates the object that represents a horizontal page break.\n ", "additionalProperties": false, "required": [ "Row", "EndColumn", "StartColumn" ], "properties": { "Row": { "type": "integer", "description": "Gets the zero based row index.\n ", "format": "int32" }, "EndColumn": { "type": "integer", "description": "Gets the end column index of this horizontal page break.\n ", "format": "int32" }, "StartColumn": { "type": "integer", "description": "Gets the start column index of this horizontal page break.\n ", "format": "int32" } } }, "VerticalPageBreakResponse": { "type": "object", "description": " Represents the VerticalPageBreak Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the VerticalPageBreak Response.\n ", "additionalProperties": false, "properties": { "VerticalPageBreak": { "description": "The class has a property that represents a vertical page break.", "allOf": [ {} ], "$ref": "#/definitions/VerticalPageBreak" } } } ] }, "HorizontalPageBreakResponse": { "type": "object", "description": " Represents the HorizontalPageBreak Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the HorizontalPageBreak Response.\n ", "additionalProperties": false, "properties": { "HorizontalPageBreak": { "description": "HorizontalPageBreak is a property of the class that represents a horizontal page break.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalPageBreak" } } } ] }, "PageSetupResponse": { "type": "object", "description": " Represents the PageSetup Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the PageSetup Response.\n ", "additionalProperties": false, "properties": { "PageSetup": { "description": "Property Summary: The class has a public property named PageSetup of type PageSetup that can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/PageSetup" } } } ] }, "PageSectionsResponse": { "type": "object", "description": " Represents the PageSections Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the PageSections Response.\n ", "additionalProperties": false, "properties": { "PageSections": { "type": "array", "description": "A property named PageSections of type List PageSection to store a collection of PageSection objects.", "items": { "$ref": "#/definitions/PageSection" } } } } ] }, "PicturesResponse": { "type": "object", "description": " Represents the Pictures Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Pictures Response.\n ", "additionalProperties": false, "properties": { "Pictures": { "description": "This class has a property called \"Pictures\" with the feature of being serialized as \"pictures\" in XML elements.", "allOf": [ {} ], "$ref": "#/definitions/Pictures" } } } ] }, "Pictures": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "properties": { "PictureList": { "type": "array", "description": "Property Summary: Contains a list of elements with the XML element name \"picture.\"", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "Picture": { "type": "object", "description": " Encapsulates the object that represents a single picture in a spreadsheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Shape" }, { "type": "object", "description": " Encapsulates the object that represents a single picture in a spreadsheet.\n ", "additionalProperties": false, "properties": { "BorderLineColor": { "description": "Represents the of the border line of a picture.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BorderWeight": { "type": "number", "description": "Gets or sets the weight of the border line of a picture in units of pt.\n ", "format": "double" }, "OriginalHeight": { "type": "integer", "description": "Gets the original height of the picture.\n ", "format": "int32" }, "OriginalWidth": { "type": "integer", "description": "Gets the original width of the picture.\n ", "format": "int32" }, "ImageFormat": { "type": "string", "description": "This class has a property called \"ImageFormat\" that allows getting and setting a string value." }, "SourceFullName": { "type": "string", "description": "Gets or sets the path and name of the source file for the linked image.\n " } } } ] }, "PivotTablesResponse": { "type": "object", "description": " Represents the PivotTables Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the PivotTables Response.\n ", "additionalProperties": false, "properties": { "PivotTables": { "description": "This class has a property named PivotTables of type PivotTables that can be both accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/PivotTables" } } } ] }, "PivotTables": { "type": "object", "description": " Represents the collection of all the PivotTable objects on the specified worksheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents the collection of all the PivotTable objects on the specified worksheet.\n ", "additionalProperties": false, "properties": { "PivotTableList": { "type": "array", "description": "Xml property \"PivotTableList\" of the class contains a list of \"LinkElement\" objects with the element name \"PivotTable\".", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "PivotTableResponse": { "type": "object", "description": " Represents the PivotTable Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the PivotTable Response.\n ", "additionalProperties": false, "properties": { "PivotTable": { "description": "PivotTable property of type PivotTable that can be both read and written.", "allOf": [ {} ], "$ref": "#/definitions/PivotTable" } } } ] }, "PivotTable": { "type": "object", "description": " Summary description for PivotTable.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Summary description for PivotTable.\n ", "additionalProperties": false, "properties": { "AltTextDescription": { "type": "string", "description": "Gets the description of the alt text" }, "AltTextTitle": { "type": "string" }, "AutoFormatType": { "type": "string" }, "BaseFields": { "type": "array", "items": { "$ref": "#/definitions/PivotField" } }, "ColumnFields": { "type": "array", "items": { "$ref": "#/definitions/PivotField" } }, "ColumnGrand": { "type": "boolean" }, "ColumnHeaderCaption": { "type": "string" }, "ColumnRange": { "$ref": "#/definitions/CellArea" }, "CustomListSort": { "type": "boolean" }, "DataBodyRange": { "$ref": "#/definitions/CellArea" }, "DataField": { "$ref": "#/definitions/PivotField" }, "DataFields": { "type": "array", "items": { "$ref": "#/definitions/PivotField" } }, "DataSource": { "type": "array", "items": { "type": "string" } }, "DisplayErrorString": { "type": "boolean" }, "DisplayImmediateItems": { "type": "boolean" }, "DisplayNullString": { "type": "boolean" }, "EnableDataValueEditing": { "type": "boolean" }, "EnableDrilldown": { "type": "boolean" }, "EnableFieldDialog": { "type": "boolean" }, "EnableFieldList": { "type": "boolean" }, "EnableWizard": { "type": "boolean" }, "ErrorString": { "type": "string" }, "FieldListSortAscending": { "type": "boolean" }, "GrandTotalName": { "type": "string" }, "HasBlankRows": { "type": "boolean" }, "Indent": { "type": "integer", "format": "int32" }, "IsAutoFormat": { "type": "boolean" }, "IsGridDropZones": { "type": "boolean" }, "IsMultipleFieldFilters": { "type": "boolean" }, "IsSelected": { "type": "boolean" }, "ItemPrintTitles": { "type": "boolean" }, "ManualUpdate": { "type": "boolean" }, "MergeLabels": { "type": "boolean" }, "MissingItemsLimit": { "type": "string" }, "Name": { "type": "string" }, "NullString": { "type": "string" }, "PageFieldOrder": { "type": "string" }, "PageFields": { "type": "array", "items": { "$ref": "#/definitions/PivotField" } }, "PageFieldWrapCount": { "type": "integer", "format": "int32" }, "PivotFilters": { "type": "array", "items": { "$ref": "#/definitions/PivotFilter" } }, "PivotTableStyleName": { "type": "string" }, "PivotTableStyleType": { "type": "string" }, "PreserveFormatting": { "type": "boolean" }, "PrintDrill": { "type": "boolean" }, "PrintTitles": { "type": "boolean" }, "RefreshDataFlag": { "type": "boolean" }, "RefreshDataOnOpeningFile": { "type": "boolean" }, "RowFields": { "type": "array", "items": { "$ref": "#/definitions/PivotField" } }, "RowGrand": { "type": "boolean" }, "RowHeaderCaption": { "type": "string" }, "RowRange": { "$ref": "#/definitions/CellArea" }, "SaveData": { "type": "boolean" }, "ShowDataTips": { "type": "boolean" }, "ShowDrill": { "type": "boolean" }, "ShowEmptyCol": { "type": "boolean" }, "ShowEmptyRow": { "type": "boolean" }, "ShowMemberPropertyTips": { "type": "boolean" }, "ShowPivotStyleColumnHeader": { "type": "boolean" }, "ShowPivotStyleColumnStripes": { "type": "boolean" }, "ShowPivotStyleLastColumn": { "type": "boolean" }, "ShowPivotStyleRowHeader": { "type": "boolean" }, "ShowPivotStyleRowStripes": { "type": "boolean" }, "ShowRowHeaderCaption": { "type": "boolean" }, "ShowValuesRow": { "type": "boolean" }, "SubtotalHiddenPageItems": { "type": "boolean" }, "TableRange1": { "$ref": "#/definitions/CellArea" }, "TableRange2": { "$ref": "#/definitions/CellArea" }, "Tag": { "type": "string" } } } ] }, "PivotField": { "type": "object", "description": " Represents a field in a PivotTable report.\n ", "additionalProperties": false, "properties": { "AutoShowCount": { "type": "integer", "description": "Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.", "format": "int32" }, "AutoShowField": { "type": "integer", "format": "int32" }, "AutoSortField": { "type": "integer", "format": "int32" }, "BaseField": { "type": "integer", "format": "int32" }, "BaseIndex": { "type": "integer", "format": "int32" }, "BaseItem": { "type": "integer", "format": "int32" }, "BaseItemPosition": { "type": "string" }, "CurrentPageItem": { "type": "integer" }, "DataDisplayFormat": { "type": "string" }, "DisplayName": { "type": "string" }, "DragToColumn": { "type": "boolean" }, "DragToData": { "type": "boolean" }, "DragToHide": { "type": "boolean" }, "DragToPage": { "type": "boolean" }, "DragToRow": { "type": "boolean" }, "Function": { "type": "string" }, "InsertBlankRow": { "type": "boolean" }, "IsAscendShow": { "type": "boolean" }, "IsAscendSort": { "type": "boolean" }, "IsAutoShow": { "type": "boolean" }, "IsAutoSort": { "type": "boolean" }, "IsAutoSubtotals": { "type": "boolean" }, "IsCalculatedField": { "type": "boolean" }, "IsIncludeNewItemsInFilter": { "type": "boolean" }, "IsInsertPageBreaksBetweenItems": { "type": "boolean" }, "IsMultipleItemSelectionAllowed": { "type": "boolean" }, "IsRepeatItemLabels": { "type": "boolean" }, "ItemCount": { "type": "integer", "format": "int32" }, "Items": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Number": { "type": "integer", "format": "int32" }, "NumberFormat": { "type": "string" }, "OriginalItems": { "type": "array", "items": { "type": "string" } }, "PivotItems": { "type": "array", "items": { "$ref": "#/definitions/PivotItem" } }, "Position": { "type": "integer", "format": "int32" }, "ShowAllItems": { "type": "boolean" }, "ShowCompact": { "type": "boolean" }, "ShowInOutlineForm": { "type": "boolean" }, "ShowSubtotalAtTop": { "type": "boolean" } } }, "PivotItem": { "type": "object", "description": " Represents a item in a PivotField report.\n ", "additionalProperties": false, "properties": { "Index": { "type": "integer", "description": "Gets the index of the pivot item in cache field.", "format": "int32" }, "IsHidden": { "type": "boolean", "description": "Represents whether the specified item visible." }, "Name": { "type": "string", "description": "Gets the name" }, "Value": { "type": "string", "description": "Gets the value of the specified item." } } }, "PivotFilter": { "type": "object", "description": "Represents a PivotFilter in PivotFilter Collection.", "additionalProperties": false, "properties": { "AutoFilter": { "description": "Gets the autofilter of the pivot filter.", "allOf": [ {} ], "$ref": "#/definitions/AutoFilter" }, "EvaluationOrder": { "type": "integer", "description": "Gets the Evaluation Order of the pivot filter.", "format": "int32" }, "FieldIndex": { "type": "integer", "description": "Gets the field index of the pivot filter.", "format": "int32" }, "FilterType": { "type": "string", "description": "Gets the autofilter type of the pivot filter." }, "ValueFieldIndex": { "type": "integer", "description": "Gets the measure field index of the pivot filter.\n ", "format": "int32" }, "MemberPropertyFieldIndex": { "type": "integer", "description": "Gets the member property field index of the pivot filter.\n ", "format": "int32" }, "Name": { "type": "string", "description": "Gets the name of the pivot filter." }, "Value1": { "type": "string", "description": "Gets the string value1 of the label pivot filter.\n " }, "Value2": { "type": "string", "description": "Gets the string value2 of the label pivot filter.\n " }, "Top10Filter": { "description": "A property that allows for setting and getting a Top10Filter object for filtering data.", "allOf": [ {} ], "$ref": "#/definitions/Top10Filter" } } }, "PivotFieldResponse": { "type": "object", "description": " Represents the PivotField Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the PivotField Response.\n ", "additionalProperties": false, "properties": { "PivotField": { "description": "This class has a property named \"PivotField\" of type PivotField which can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/PivotField" } } } ] }, "PivotFiltersResponse": { "type": "object", "description": " Represents the PivotFilters Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the PivotFilters Response.\n ", "additionalProperties": false, "properties": { "PivotFilters": { "type": "array", "description": "Property summary: Contains a list of PivotFilter objects.", "items": { "$ref": "#/definitions/PivotFilter" } } } } ] }, "PivotFilterResponse": { "type": "object", "description": " Represents the PivotFilter Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the PivotFilter Response.\n ", "additionalProperties": false, "properties": { "PivotFilter": { "description": "Property Summary: Contains a pivot filter for data manipulation.", "allOf": [ {} ], "$ref": "#/definitions/PivotFilter" } } } ] }, "PivotTableFieldRequest": { "type": "object", "description": "Indicates pivot table field request", "additionalProperties": false, "properties": { "Data": { "type": "array", "description": "Intdex array.", "items": { "type": "integer", "format": "int32" } } } }, "CellsDocumentPropertiesResponse": { "type": "object", "description": " Represents the CellsDocumentProperties Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the CellsDocumentProperties Response.\n ", "additionalProperties": false, "properties": { "DocumentProperties": { "description": "The class has a property that represents the document properties of cells.", "allOf": [ {} ], "$ref": "#/definitions/CellsDocumentProperties" } } } ] }, "CellsDocumentProperties": { "type": "object", "description": "Excel properties", "additionalProperties": false, "properties": { "DocumentPropertyList": { "type": "array", "description": "Document property list.", "items": { "$ref": "#/definitions/CellsDocumentProperty" } } } }, "CellsDocumentPropertyResponse": { "type": "object", "description": " Represents the CellsDocumentProperty Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the CellsDocumentProperty Response.\n ", "additionalProperties": false, "properties": { "DocumentProperty": { "description": "A property named DocumentProperty of type CellsDocumentProperty is defined with get and set accessors.", "allOf": [ {} ], "$ref": "#/definitions/CellsDocumentProperty" } } } ] }, "WorkbookEncryptionRequest": { "type": "object", "description": "Used by workbook encryption/decryption requests.", "additionalProperties": false, "required": [ "KeyLength" ], "properties": { "EncryptionType": { "type": "string", "description": "Workbook encription type." }, "KeyLength": { "type": "integer", "description": "Encription key length.", "format": "int32" }, "Password": { "type": "string", "description": "Encription password." } } }, "ProtectWorkbookRequest": { "type": "object", "description": "Indicates protect workbook request", "additionalProperties": false, "properties": { "AwaysOpenReadOnly": { "type": "boolean", "description": "Indicates aways open read-only." }, "EncryptWithPassword": { "type": "string", "description": "Indicates encrypt with password." }, "ProtectCurrentSheet": { "description": "Represents the various types of protection options available for a worksheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/Protection" }, "ProtectAllSheets": { "description": "Represents the various types of protection options available for all worksheets.\n ", "allOf": [ {} ], "$ref": "#/definitions/Protection" }, "ProtectWorkbookStructure": { "type": "string", "description": "Indicates protect workbook structure. All, Contents, Objects, Scenarios, Structure, Windows, and None." }, "DigitalSignature": { "description": "Indicates signature in file.", "allOf": [ {} ], "$ref": "#/definitions/DigitalSignature" }, "MarkAsFinal": { "type": "boolean", "description": "Indicates mark as final." } } }, "Protection": { "type": "object", "description": "Represents the various types of protection options available for a worksheet.\n ", "additionalProperties": false, "properties": { "AllowDeletingColumn": { "type": "boolean", "description": "Represents if the deletion of columns is allowed on a protected worksheet.\n " }, "AllowDeletingRow": { "type": "boolean", "description": "Represents if the deletion of rows is allowed on a protected worksheet.\n " }, "AllowFiltering": { "type": "boolean", "description": "Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.\n " }, "AllowFormattingCell": { "type": "boolean", "description": "Represents if the formatting of cells is allowed on a protected worksheet.\n " }, "AllowFormattingColumn": { "type": "boolean", "description": "Represents if the formatting of columns is allowed on a protected worksheet\n " }, "AllowFormattingRow": { "type": "boolean", "description": "Represents if the formatting of rows is allowed on a protected worksheet\n " }, "AllowInsertingColumn": { "type": "boolean", "description": "Represents if the insertion of columns is allowed on a protected worksheet\n " }, "AllowInsertingHyperlink": { "type": "boolean", "description": "Represents if the insertion of hyperlinks is allowed on a protected worksheet\n " }, "AllowInsertingRow": { "type": "boolean", "description": "Represents if the insertion of rows is allowed on a protected worksheet\n " }, "AllowSorting": { "type": "boolean", "description": "Represents if the sorting option is allowed on a protected worksheet.\n " }, "AllowUsingPivotTable": { "type": "boolean", "description": "Represents if the user is allowed to manipulate pivot tables on a protected worksheet.\n " }, "AllowEditingContent": { "type": "boolean", "description": "Represents if the user is allowed to edit contents of locked cells on a protected worksheet.\n " }, "AllowEditingObject": { "type": "boolean", "description": "Represents if the user is allowed to manipulate drawing objects on a protected worksheet.\n " }, "AllowEditingScenario": { "type": "boolean", "description": "Represents if the user is allowed to edit scenarios on a protected worksheet.\n " }, "Password": { "type": "string", "description": "Represents the password to protect the worksheet.\n " }, "AllowSelectingLockedCell": { "type": "boolean", "description": "Represents if the user is allowed to select locked cells on a protected worksheet.\n " }, "AllowSelectingUnlockedCell": { "type": "boolean", "description": "Represents if the user is allowed to select unlocked cells on a protected worksheet.\n " } } }, "DigitalSignature": { "type": "object", "description": "Signature in file.\n ", "additionalProperties": false, "properties": { "Comments": { "type": "string", "description": "The purpose to signature." }, "SignTime": { "type": "string", "description": "The time when the document was signed." }, "Id": { "type": "string", "description": "Specifies a GUID which can be cross-referenced with the GUID of the signature line stored in the document content. Default value is Empty (all zeroes) Guid." }, "Password": { "type": "string", "description": "Specifies the text of actual signature in the digital signature. Default value is Empty.\n " }, "Image": { "type": "string", "description": "Specifies an image for the digital signature. Default value is null.", "format": "byte" }, "ProviderId": { "type": "string", "description": "Specifies the class ID of the signature provider. Default value is Empty (all zeroes) Guid.\n " }, "IsValid": { "type": "boolean", "description": "If this digital signature is valid and the document has not been tampered with, this value will be true." }, "XAdESType": { "type": "string", "description": "XAdES type. Default value is None(XAdES is off)." } } }, "PasswordRequest": { "type": "object", "description": "Used for password data transfer.", "additionalProperties": false, "properties": { "Password": { "type": "string", "description": "Password." } } }, "RangeCopyRequest": { "type": "object", "description": "Indicates range copy request", "additionalProperties": false, "properties": { "Operate": { "type": "string", "description": "copydata, copystyle, copyto, copyvalue." }, "Source": { "description": "Source range. ", "allOf": [ {} ], "$ref": "#/definitions/Range" }, "Target": { "description": "Target range.", "allOf": [ {} ], "$ref": "#/definitions/Range" }, "TargetWorkbook": { "type": "string" }, "PasteOptions": { "description": "Represents the paste special options.\n ", "allOf": [ {} ], "$ref": "#/definitions/PasteOptions" } } }, "PasteOptions": { "type": "object", "description": "Represents the paste special options.\n ", "additionalProperties": false, "properties": { "OnlyVisibleCells": { "type": "boolean", "description": "True means only copying visible cells.\n " }, "PasteType": { "type": "string", "description": "The paste special type.\n " }, "SkipBlanks": { "type": "boolean", "description": "Indicates whether skips blank cells.\n " }, "Transpose": { "type": "boolean", "description": "True to transpose rows and columns when the range is pasted. The default value is False.\n " } } }, "RangeSetStyleRequest": { "type": "object", "description": "Indicates range set style request.", "additionalProperties": false, "properties": { "Range": { "description": "Encapsulates the object that represents a range of cells within a spreadsheet.", "allOf": [ {} ], "$ref": "#/definitions/Range" }, "Style": { "description": "Represents display style of excel document,such as font,color,alignment,border,etc.\n ", "allOf": [ {} ], "$ref": "#/definitions/Style" } } }, "RangeValueResponse": { "type": "object", "description": " Represents the RangeValue Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the RangeValue Response.\n ", "additionalProperties": false, "properties": { "CellsList": { "type": "array", "description": "Property Summary: Contains a list of elements labeled as \"Cell\".", "items": { "$ref": "#/definitions/Cell" } } } } ] }, "RangeSortRequest": { "type": "object", "description": "Indicates range sort request", "additionalProperties": false, "properties": { "DataSorter": { "description": "Summary description for DataSorter.", "allOf": [ {} ], "$ref": "#/definitions/DataSorter" }, "CellArea": { "description": "Encapsulates the object that represents a range of cells within a spreadsheet.", "allOf": [ {} ], "$ref": "#/definitions/Range" } } }, "RangeSetOutlineBorderRequest": { "type": "object", "description": "Indicates range set outline border request.", "additionalProperties": false, "properties": { "Range": { "description": "Encapsulates the object that represents a range of cells within a spreadsheet.", "allOf": [ {} ], "$ref": "#/definitions/Range" }, "borderEdge": { "type": "string", "description": "LeftBorder, RightBorder, TopBorder, BottomBorder, DiagonalDown, DiagonalUp, Vertical and Horizontal." }, "borderStyle": { "type": "string", "description": "None, Thin, Medium, Dashed, Dotted, Thick, Double, Hair, MediumDashed, DashDot, MediumDashDot, DashDotDot, MediumDashDotDot and SlantedDashDot." }, "borderColor": { "description": "Border color.", "allOf": [ {} ], "$ref": "#/definitions/Color" } } }, "RangeConvertRequest": { "type": "object", "description": "Indicates range copy request", "additionalProperties": false, "required": [ "ImageType" ], "properties": { "Source": { "description": "Source range. ", "allOf": [ {} ], "$ref": "#/definitions/Range" }, "ImageType": { "description": "Target range.", "enum": [ "Unknown", "Emf", "Wmf", "Pict", "Jpeg", "Png", "Bmp", "Gif", "Tiff", "Svg", "Svm", "Gltf", "OfficeCompatibleEmf", "WebP" ], "allOf": [ {} ] }, "ImageOrPrintOptions": { "description": "Represents the paste special options.\n ", "allOf": [ {} ], "$ref": "#/definitions/ImageOrPrintOptions" }, "PageSetup": { "$ref": "#/definitions/PageSetup" } } }, "ShapesResponse": { "type": "object", "description": " Represents the Shapes Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Shapes Response.\n ", "additionalProperties": false, "properties": { "Shapes": { "description": "The class has a property called \"Shapes\" with XML serialization attribute \"XmlElement\" for specifying the element name in the XML representation.", "allOf": [ {} ], "$ref": "#/definitions/Shapes" } } } ] }, "Shapes": { "type": "object", "description": " Represents all the shape in a worksheet/chart.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents all the shape in a worksheet/chart.\n ", "additionalProperties": false, "properties": { "ShapeList": { "type": "array", "description": "A public property named \"ShapeList\" of type List LinkElement for storing a collection of link elements.", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "ShapeResponse": { "type": "object", "description": " Represents the Shape Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Shape Response.\n ", "additionalProperties": false, "properties": { "Shape": { "description": "Property summary: The class has a public property named Shape of type Shape with both getter and setter methods.", "allOf": [ {} ], "$ref": "#/definitions/Shape" } } } ] }, "SparklineGroupsResponse": { "type": "object", "description": " Represents the SparklineGroups Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the SparklineGroups Response.\n ", "additionalProperties": false, "properties": { "SparklineGroups": { "description": "This class has a property named \"SparklineGroups\" of type \"SparklineGroups\" for managing sparkline groups.", "allOf": [ {} ], "$ref": "#/definitions/SparklineGroups" } } } ] }, "SparklineGroups": { "type": "object", "description": "Encapsulates a collection of Aspose.Cells.Charts.SparklineGroup objects.\n ", "additionalProperties": false, "properties": { "SparklineGroupList": { "type": "array", "description": "Encapsulates a collection of Aspose.Cells.Charts.SparklineGroup objects.\n ", "items": { "$ref": "#/definitions/SparklineGroup" } } } }, "SparklineGroup": { "type": "object", "description": " is organized into sparkline group. A SparklineGroup contains a variable number of sparkline items. A sparkline group specifies the type, display settings and axis settings for the sparklines.\n ", "additionalProperties": false, "properties": { "DisplayHidden": { "type": "boolean", "description": "Indicates whether to show data in hidden rows and columns.\n " }, "FirstPointColor": { "description": "Gets and sets the color of the first point of data in the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "HighPointColor": { "description": "Gets and sets the color of the highest points of data in the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "HorizontalAxisColor": { "description": "Gets and sets the color of the horizontal axis in the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "HorizontalAxisDateRange": { "type": "string", "description": "Represents the range that contains the date values for the sparkline data.\n " }, "LastPointColor": { "description": "Gets and sets the color of the last point of data in the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "LineWeight": { "type": "number", "description": "Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.\n ", "format": "double" }, "LowPointColor": { "description": "Gets and sets the color of the lowest points of data in the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "MarkersColor": { "description": "Gets and sets the color of points in each line sparkline in the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "NegativePointsColor": { "description": "Gets and sets the color of the negative values on the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "PlotEmptyCellsType": { "type": "string", "description": "Indicates how to plot empty cells.\n " }, "PlotRightToLeft": { "type": "boolean", "description": "Indicates whether the plot data is right to left.\n " }, "PresetStyle": { "type": "string", "description": "Gets and sets the preset style type of the sparkline group.\n " }, "SeriesColor": { "description": "Gets and sets the color of the sparklines in the sparkline group.\n ", "allOf": [ {} ], "$ref": "#/definitions/CellsColor" }, "ShowFirstPoint": { "type": "boolean", "description": "Indicates whether to highlight the first point of data in the sparkline group.\n " }, "ShowHighPoint": { "type": "boolean", "description": "Indicates whether to highlight the highest points of data in the sparkline group.\n " }, "ShowHorizontalAxis": { "type": "boolean", "description": "Indicates whether to show the sparkline horizontal axis.\n The horizontal axis appears if the sparkline has data that crosses the zero axis.\n " }, "ShowLastPoint": { "type": "boolean", "description": "Indicates whether to highlight the last point of data in the sparkline group.\n " }, "ShowLowPoint": { "type": "boolean", "description": "Indicates whether to highlight the lowest points of data in the sparkline group.\n " }, "ShowMarkers": { "type": "boolean", "description": "Indicates whether to highlight each point in each line sparkline in the sparkline group.\n " }, "ShowNegativePoints": { "type": "boolean", "description": "Indicates whether to highlight the negative values on the sparkline group with a different color or marker.\n " }, "SparklineCollection": { "type": "array", "description": "Gets the collection of object.\n ", "items": { "$ref": "#/definitions/Sparkline" } }, "Type": { "type": "string", "description": "Indicates the sparkline type of the sparkline group.\n " }, "VerticalAxisMaxValue": { "type": "number", "description": "Gets and sets the custom maximum value for the vertical axis.\n ", "format": "double" }, "VerticalAxisMaxValueType": { "type": "string", "description": "Represents the vertical axis maximum value type.\n " }, "VerticalAxisMinValue": { "type": "number", "description": "Gets and sets the custom minimum value for the vertical axis.\n ", "format": "double" }, "VerticalAxisMinValueType": { "type": "string", "description": "Represents the vertical axis minimum value type.\n " } } }, "Sparkline": { "type": "object", "description": "A sparkline represents a tiny chart or graphic in a worksheet cell that provides a visual representation of data.\n ", "additionalProperties": false, "required": [ "Column", "Row" ], "properties": { "Column": { "type": "integer", "description": "Gets the column index of the sparkline.\n ", "format": "int32" }, "DataRange": { "type": "string", "description": "Represents the data range of the sparkline.\n " }, "Row": { "type": "integer", "description": "Gets the row index of the sparkline.\n ", "format": "int32" } } }, "SparklineGroupResponse": { "type": "object", "description": " Represents the SparklineGroup Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the SparklineGroup Response.\n ", "additionalProperties": false, "properties": { "SparklineGroup": { "description": "A property that allows access to a Sparkline group containing multiple Sparkline objects.", "allOf": [ {} ], "$ref": "#/definitions/SparklineGroup" } } } ] }, "CharacterCountOptions": { "type": "object", "description": "Character Count Options.", "additionalProperties": false, "properties": { "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" } } }, "WordsCountOptions": { "type": "object", "description": "Words Count Options", "additionalProperties": false, "properties": { "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" } } }, "SpecifyWordsCountOptions": { "type": "object", "additionalProperties": false, "properties": { "DataSource": { "$ref": "#/definitions/DataSource" }, "FileInfo": { "$ref": "#/definitions/FileInfo" }, "SearchWord": { "type": "string" } } }, "StorageExist": { "type": "object", "description": "Storage exists", "additionalProperties": false, "required": [ "Exists" ], "properties": { "Exists": { "type": "boolean", "description": "Shows that the storage exists.\n " } } }, "ObjectExist": { "type": "object", "description": "Object exists", "additionalProperties": false, "required": [ "Exists", "IsFolder" ], "properties": { "Exists": { "type": "boolean", "description": "Indicates that the file or folder exists." }, "IsFolder": { "type": "boolean", "description": "True if it is a folder, false if it is a file." } } }, "DiscUsage": { "type": "object", "description": "Class for disc space information.", "additionalProperties": false, "required": [ "UsedSize", "TotalSize" ], "properties": { "UsedSize": { "type": "integer", "description": "Application used disc space.", "format": "int64" }, "TotalSize": { "type": "integer", "description": "Total disc space.", "format": "int64" } } }, "FileVersions": { "type": "object", "description": "File versions FileVersion.", "additionalProperties": false, "properties": { "Value": { "type": "array", "description": "File versions FileVersion.", "items": { "$ref": "#/definitions/FileVersion" } } } }, "FileVersion": { "type": "object", "description": "File Version", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StorageFile" }, { "type": "object", "description": "File Version", "additionalProperties": false, "required": [ "IsLatest" ], "properties": { "VersionId": { "type": "string", "description": "File Version ID." }, "IsLatest": { "type": "boolean", "description": "Specifies whether the file is (true) or is not (false) the latest version of an file." } } } ] }, "AddTextOptions": { "type": "object", "description": "Class summary: The features of this class include hands-on learning activities, group projects, interactive discussions, guest speakers, and field trips to real-world applications.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "description": "Class summary: The features of this class include hands-on learning activities, group projects, interactive discussions, guest speakers, and field trips to real-world applications.", "additionalProperties": false, "required": [ "SelectPoistion", "SkipEmptyCells" ], "properties": { "Name": { "type": "string", "description": "The class has a public property named \"Name\" with a getter and setter method." }, "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "ScopeOptions": { "description": "Specifies the range of cells within the worksheet where the spreadsheet operations will be performed. This parameter allows users to define the exact area to be processed, ensuring that operations are applied only to the designated cells.", "allOf": [ {} ], "$ref": "#/definitions/ScopeOptions" }, "Text": { "type": "string", "description": "Add text content." }, "SelectPoistion": { "description": "Represents where text should be inserted or selected in the spreadsheet.", "enum": [ "None", "AtTheBeginning", "AtTheEnd", "BeforeText", "AfterText" ], "allOf": [ {} ] }, "SelectText": { "type": "string", "description": "Selected text of cell where text should be inserted or selected in the spreadsheet." }, "SkipEmptyCells": { "type": "boolean", "description": "Indicates whether empty cells should be skipped during processing." } } } ] }, "ScopeOptions": { "type": "object", "description": "Specifies the range of cells within the worksheet where the spreadsheet operations will be performed. This parameter allows users to define the exact area to be processed, ensuring that operations are applied only to the designated cells.", "additionalProperties": false, "required": [ "Scope" ], "properties": { "Scope": { "description": "ScopeOptionsType is a type that represents options or settings that are specific to a particular scope.", "enum": [ "EntireWorkbook", "Workbook", "EntireWorksheet", "Worksheet", "ListObject", "SelectionOlny", "Range" ], "allOf": [ {} ] }, "ScopeItems": { "type": "array", "description": "Specifies the designated work area within the worksheet where operations are to be performed. ", "items": { "$ref": "#/definitions/ScopeItem" } } } }, "ScopeItem": { "type": "object", "description": "Define the specific range in your Excel worksheet where you want the spreadsheet operations to be performed. This ensures that only the cells within the selected range are processed, and any operations are confined to this area.", "additionalProperties": false, "properties": { "Worksheet": { "type": "string", "description": "The specific worksheet of spreadsheet." }, "Ranges": { "type": "array", "description": "The specific ranges of worksheet.", "items": { "type": "string" } } } }, "TrimContentOptions": { "type": "object", "additionalProperties": false, "required": [ "TrimContent", "TrimLeading", "TrimTrailing", "TrimSpaceBetweenWordTo1", "TrimNonBreakingSpaces", "RemoveExtraLineBreaks", "RemoveAllLineBreaks" ], "properties": { "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "TrimContent": { "type": "string", "description": "Trim Content" }, "TrimLeading": { "type": "boolean", "description": "If the trim leading value is true, the trim content before and after cell values will be deleted." }, "TrimTrailing": { "type": "boolean", "description": "If the trim trailing value is true, the trim content before and after cell values will be deleted." }, "TrimSpaceBetweenWordTo1": { "type": "boolean", "description": "When the trim space between word to 1 parameter is true, it enables the removal of extra spaces between words within a cell, ensuring that only a single space is maintained between words." }, "TrimNonBreakingSpaces": { "type": "boolean" }, "RemoveExtraLineBreaks": { "type": "boolean", "description": "When this parameter is enabled (set to True), it deletes extra line breaks within the selected range, ensuring that only necessary line breaks are retained." }, "RemoveAllLineBreaks": { "type": "boolean", "description": "When this parameter is enabled (set to True), it removes all line breaks within the selected range, resulting in a continuous block of text without any line breaks." }, "ScopeOptions": { "description": "Specifies the range of cells within the worksheet where the spreadsheet operations will be performed. This parameter allows users to define the exact area to be processed, ensuring that operations are applied only to the designated cells.", "allOf": [ {} ], "$ref": "#/definitions/ScopeOptions" } } }, "WordCaseOptions": { "type": "object", "description": "I'm here to assist you. Please provide the features you would like me to summarize for the class.\n ", "additionalProperties": false, "required": [ "WordCaseType" ], "properties": { "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "WordCaseType": { "enum": [ "None", "UpperCase", "LowerCase", "ProperCase", "SentenceCase" ] }, "ScopeOptions": { "$ref": "#/definitions/ScopeOptions" } } }, "RemoveCharactersOptions": { "type": "object", "description": "Class summary: The class features discussing effective communication strategies, developing problem-solving skills, and increasing self-awareness for personal growth.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "description": "Class summary: The class features discussing effective communication strategies, developing problem-solving skills, and increasing self-awareness for personal growth.", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Name property with a getter and setter override that returns a string." }, "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "ScopeOptions": { "description": "Specifies the range of cells within the worksheet where the spreadsheet operations will be performed. This parameter allows users to define the exact area to be processed, ensuring that operations are applied only to the designated cells.", "allOf": [ {} ], "$ref": "#/definitions/ScopeOptions" }, "RemoveCharactersByCharacter": { "$ref": "#/definitions/RemoveCharactersByCharacter" }, "RemoveCharactersByPosition": { "$ref": "#/definitions/RemoveCharactersByPosition" } } } ] }, "RemoveCharactersByCharacter": { "type": "object", "description": "Class summary: The features include fast and reliable performance, high-quality camera with portrait mode, long-lasting battery life, and a durable water-resistant design.\n ", "additionalProperties": false, "required": [ "RemoveTextMethod", "RemoveCharacterSetsType" ], "properties": { "RemoveTextMethod": { "description": "Property: \"RemoveTextMethod\" is serialized using a string representation of the enum value.", "enum": [ "RemoveCustomCharacter", "RemoveCharacterSets", "RemoveSubString" ], "allOf": [ {} ] }, "RemoveCharacters": { "type": "array", "items": { "type": "string" } }, "RemoveCharacterSetsType": { "enum": [ "NonPrintingCharacters", "TextCharacters", "NumericCharacters", "Symbols", "PunctuationMarks" ] } } }, "RemoveCharactersByPosition": { "type": "object", "description": "Class summary: Important features to consider when designing a new website include user-friendly navigation, responsive design for different devices, visually appealing layouts, and fast loading speed.\n ", "additionalProperties": false, "required": [ "TheFirstNCharacters", "TheLastNCharacters" ], "properties": { "TheFirstNCharacters": { "type": "integer", "description": "This property allows access to a public integer named \"TheFirstNCharacters\" for getting and setting its value.", "format": "int32" }, "TheLastNCharacters": { "type": "integer", "format": "int32" }, "AllCharactersBeforeText": { "type": "string" }, "AllCharactersAfterText": { "type": "string" } } }, "ConvertTextOptions": { "type": "object", "description": "Class summary: The features of the new smartphone include a high-resolution display, multiple camera lenses for versatile photography, a fast processor for seamless performance, and a larger battery for extended usage time.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "description": "Class summary: The features of the new smartphone include a high-resolution display, multiple camera lenses for versatile photography, a fast processor for seamless performance, and a larger battery for extended usage time.", "additionalProperties": false, "required": [ "ConvertTextType" ], "properties": { "Name": { "type": "string", "description": "The class has a public property called \"Name\" of type string that can be accessed and modified." }, "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "ScopeOptions": { "description": "Specifies the range of cells within the worksheet where the spreadsheet operations will be performed. This parameter allows users to define the exact area to be processed, ensuring that operations are applied only to the designated cells.", "allOf": [ {} ], "$ref": "#/definitions/ScopeOptions" }, "ConvertTextType": { "enum": [ "ConvertNumberToText", "ConvertCharacters", "ConvertLinebreak", "ConvertWriteSpace", "ConvertAccentedChars" ] }, "SourceCharacters": { "type": "string" }, "TargetCharacters": { "type": "string" } } } ] }, "RemoveDuplicatesOptions": { "type": "object", "description": "I'm here to help! Just let me know the features you would like me to summarize for you.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "description": "I'm here to help! Just let me know the features you would like me to summarize for you.", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "The class has a public property \"Name\" of type string that can be both read and written." }, "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "ScopeOptions": { "description": "Specifies the range of cells within the worksheet where the spreadsheet operations will be performed. This parameter allows users to define the exact area to be processed, ensuring that operations are applied only to the designated cells.", "allOf": [ {} ], "$ref": "#/definitions/ScopeOptions" } } } ] }, "ExtractTextOptions": { "type": "object", "description": "I'm happy to help! Could you please provide me with the features you would like me to summarize for you?", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "description": "I'm happy to help! Could you please provide me with the features you would like me to summarize for you?", "additionalProperties": false, "required": [ "ExtractTextType", "BeforePosition", "AfterPosition" ], "properties": { "Name": { "type": "string", "description": "This class has a public property for storing and retrieving a name value." }, "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "Worksheet": { "type": "string" }, "Range": { "type": "string" }, "ExtractTextType": { "enum": [ "ExtractFirstCharacter", "ExtractFirstWord", "ExtractLastCharacter", "ExtractLastWord", "ExtractTextBefore", "ExtractTextAfter", "ExtractBetweenSpecifiedCharacters", "ExtractAllNumbers", "GetTextFromAnyPosition" ] }, "BeforeText": { "type": "string" }, "AfterText": { "type": "string" }, "BeforePosition": { "type": "integer", "format": "int32" }, "AfterPosition": { "type": "integer", "format": "int32" }, "OutPositionRange": { "type": "string" } } } ] }, "SplitTextOptions": { "type": "object", "description": "Appliance features: 1. Automatic defrost system 2. Energy-efficient LED lighting 3. Adjustable glass shelves 4. Ice and water dispenser with filtration system", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/BaseOperateOptions" }, { "type": "object", "description": "Appliance features: 1. Automatic defrost system 2. Energy-efficient LED lighting 3. Adjustable glass shelves 4. Ice and water dispenser with filtration system", "additionalProperties": false, "required": [ "SplitDelimitersType", "KeepDelimitersInResultingCells", "KeepDelimitersPosition", "HowToSplit" ], "properties": { "Name": { "type": "string", "description": "The property \"Name\" is a publicly accessible and overridable property of type string in the class." }, "DataSource": { "description": "Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.", "allOf": [ {} ], "$ref": "#/definitions/DataSource" }, "FileInfo": { "description": "Represents file information. Include of filename, filesize, and file content(base64String).", "allOf": [ {} ], "$ref": "#/definitions/FileInfo" }, "Worksheet": { "type": "string" }, "Range": { "type": "string" }, "SplitDelimitersType": { "enum": [ "Comma", "Space", "Semicolon", "LineBreak", "Custom" ] }, "CustomDelimiter": { "type": "string" }, "KeepDelimitersInResultingCells": { "type": "boolean" }, "KeepDelimitersPosition": { "enum": [ "None", "AtTheBeginning", "AtTheEnd", "BeforeText", "AfterText" ] }, "HowToSplit": { "enum": [ "None", "SplitToColumns", "SplitToRows" ] } } } ] }, "TextItemsResponse": { "type": "object", "description": " Represents the TextItems Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the TextItems Response.\n ", "additionalProperties": false, "properties": { "TextItems": { "description": "This property allows access to a collection of TextItems.", "allOf": [ {} ], "$ref": "#/definitions/TextItems" } } } ] }, "TextItems": { "type": "object", "description": "Represents text item collection.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents text item collection.", "additionalProperties": false, "properties": { "TextItemList": { "type": "array", "description": "Represents text item collection", "items": { "$ref": "#/definitions/TextItem" } } } } ] }, "NamesResponse": { "type": "object", "description": " Represents the Names Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Names Response.\n ", "additionalProperties": false, "properties": { "Names": { "description": "Property: This property represents an XML element named \"names\" and holds a Names object.", "allOf": [ {} ], "$ref": "#/definitions/Names" } } } ] }, "Names": { "type": "object", "description": " Represents a collection of all the objects in the spreadsheet.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a collection of all the objects in the spreadsheet.\n ", "additionalProperties": false, "required": [ "Count" ], "properties": { "Count": { "type": "integer", "description": "This class property is tagged as an XML element named \"count\" and stores an integer value.", "format": "int32" }, "NameList": { "type": "array", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "Name": { "type": "object", "description": " Represents a defined name for a range of cells.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents a defined name for a range of cells.\n ", "additionalProperties": false, "properties": { "Comment": { "type": "string", "description": "Gets and sets the comment of the name.\n Only applies for Excel 2007.\n " }, "WorksheetIndex": { "type": "integer", "description": "Property Summary: WorksheetIndex is an optional integer property marked with the XmlElement attribute \"worksheetindex\".", "format": "int32" }, "IsReferred": { "type": "boolean", "description": "Indicates whether this name is referred by other formulas.\n " }, "IsVisible": { "type": "boolean", "description": "Indicates whether the name is visible.\n " }, "R1C1RefersTo": { "type": "string", "description": "Gets or sets a R1C1 reference of the .\n " }, "RefersTo": { "type": "string", "description": "Returns or sets the formula that the name is defined to refer to, beginning with an equal sign.\n " }, "Text": { "type": "string", "description": "Gets the name text of the object.\n " } } } ] }, "NameResponse": { "type": "object", "description": " Represents the Name Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Name Response.\n ", "additionalProperties": false, "properties": { "Name": { "description": "A public property that allows getting and setting a value of type \"Name\".", "allOf": [ {} ], "$ref": "#/definitions/Name" } } } ] }, "WorkbookResponse": { "type": "object", "description": " Represents the Workbook Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Workbook Response.\n ", "additionalProperties": false, "properties": { "Workbook": { "description": "Workbook property of the class allows access to and modification of a Workbook object.", "allOf": [ {} ], "$ref": "#/definitions/Workbook" } } } ] }, "WorkbookReplaceResponse": { "type": "object", "description": " Represents the WorkbookReplace Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the WorkbookReplace Response.\n ", "additionalProperties": false, "required": [ "Matches" ], "properties": { "Matches": { "type": "integer", "description": "Property summary: An integer property named \"Matches\" with an XmlElement attribute.", "format": "int32" }, "Workbook": { "$ref": "#/definitions/LinkElement" } } } ] }, "SplitResultResponse": { "type": "object", "description": " Represents the SplitResult Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the SplitResult Response.\n ", "additionalProperties": false, "properties": { "Result": { "description": "Gets or sets the splitting result.", "allOf": [ {} ], "$ref": "#/definitions/SplitResult" } } } ] }, "SplitResult": { "type": "object", "description": "Represents the result of the file split.", "additionalProperties": false, "properties": { "Documents": { "type": "array", "description": "Represents cells cloud file information.", "items": { "$ref": "#/definitions/CellsCloudFileInfo" } } } }, "WorkbookSettingsResponse": { "type": "object", "description": " Represents the WorkbookSettings Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the WorkbookSettings Response.\n ", "additionalProperties": false, "properties": { "settings": { "description": "The class has a public property called \"settings\" of type WorkbookSettings that can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/WorkbookSettings" } } } ] }, "WorkbookSettings": { "type": "object", "description": " Represents all settings of the workbook.\n ", "additionalProperties": false, "properties": { "AutoCompressPictures": { "type": "boolean", "description": "Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.\n " }, "AutoRecover": { "type": "boolean", "description": "Indicates whether the file is mark for auto-recovery.\n " }, "BuildVersion": { "type": "string", "description": "Specifies the incremental public release of the application.\n " }, "CalcMode": { "type": "string", "description": "It specifies whether to calculate formulas manually,\n automatically or automatically except for multiple table operations.\n " }, "CalculationId": { "type": "string", "description": "Specifies the version of the calculation engine used to calculate values in the workbook.\n " }, "CheckComptiliblity": { "type": "boolean", "description": "Indicates whether check comptiliblity when saving workbook.\n \n Remarks:\n The default value is true.\n " }, "CheckExcelRestriction": { "type": "boolean", "description": "Whether check restriction of excel file when user modify cells related objects.\n For example, excel does not allow inputting string value longer than 32K.\n When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception.\n If this property is false, we will accept your input string value as the cell's value so that later\n you can output the complete string value for other file formats such as CSV.\n However, if you have set such kind of value that is invalid for excel file format,\n you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.\n " }, "CrashSave": { "type": "boolean", "description": "indicates whether the application last saved the workbook file after a crash.\n " }, "CreateCalcChain": { "type": "boolean", "description": "Whether creates calculated formulas chain. Default is false.\n " }, "DataExtractLoad": { "type": "boolean", "description": "indicates whether the application last opened the workbook for data recovery.\n " }, "Date1904": { "type": "boolean", "description": "Gets or sets a value which represents if the workbook uses the 1904 date system.\n " }, "DisplayDrawingObjects": { "type": "string", "description": "Indicates whether and how to show objects in the workbook.\n " }, "EnableMacros": { "type": "boolean", "description": "Enable macros;\n " }, "FirstVisibleTab": { "type": "integer", "description": "Gets or sets the first visible worksheet tab.\n ", "format": "int32" }, "HidePivotFieldList": { "type": "boolean", "description": "Gets and sets whether hide the field list for the PivotTable.\n " }, "IsDefaultEncrypted": { "type": "boolean", "description": "Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.\n " }, "IsHidden": { "type": "boolean", "description": "Indicates whether this workbook is hidden.\n " }, "IsHScrollBarVisible": { "type": "boolean", "description": "Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.\n " }, "IsMinimized": { "type": "boolean", "description": "Represents whether the generated spreadsheet will be opened Minimized.\n " }, "IsVScrollBarVisible": { "type": "boolean", "description": "Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.\n " }, "Iteration": { "type": "boolean", "description": "Indicates whether enable iterative calculation to resolve circular references.\n " }, "LanguageCode": { "type": "string", "description": "Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.\n " }, "MaxChange": { "type": "number", "description": "Returns or sets the maximum number of change to resolve a circular reference.\n ", "format": "double" }, "MaxIteration": { "type": "integer", "description": "Returns or sets the maximum number of iterations to resolve a circular reference.\n ", "format": "int32" }, "MemorySetting": { "type": "string", "description": "Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets.\n " }, "NumberDecimalSeparator": { "type": "string", "description": "Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.\n " }, "NumberGroupSeparator": { "type": "string", "description": "Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region.\n " }, "ParsingFormulaOnOpen": { "type": "boolean", "description": "Indicates whether parsing the formula when reading the file.\n " }, "PrecisionAsDisplayed": { "type": "boolean", "description": "True if calculations in this workbook will be done using only the precision of the numbers as they're displayed\n " }, "RecalculateBeforeSave": { "type": "boolean", "description": "Indicates whether to recalculate before saving the document.\n " }, "ReCalculateOnOpen": { "type": "boolean", "description": "Indicates whether re-calculate all formulas on opening file.\n " }, "RecommendReadOnly": { "type": "boolean", "description": "Indicates if the Read Only Recommended option is selected.\n " }, "Region": { "type": "string", "description": "Gets or sets the regional settings for workbook.\n " }, "RemovePersonalInformation": { "type": "boolean", "description": "True if personal information can be removed from the specified workbook.\n " }, "RepairLoad": { "type": "boolean", "description": "Indicates whether the application last opened the workbook in safe or repair mode.\n " }, "Shared": { "type": "boolean", "description": "Gets or sets a value that indicates whether the Workbook is shared.\n " }, "SheetTabBarWidth": { "type": "integer", "description": "Width of worksheet tab bar (in 1/1000 of window width).\n ", "format": "int32" }, "ShowTabs": { "type": "boolean", "description": "Get or sets a value whether the Workbook tabs are displayed.\n " }, "UpdateAdjacentCellsBorder": { "type": "boolean", "description": "Indicates whether update adjacent cells' border.\n " }, "UpdateLinksType": { "type": "string", "description": "Gets and sets how updates external links when the workbook is opened.\n " }, "WindowHeight": { "type": "number", "description": "The height of the window, in unit of point.\n ", "format": "double" }, "WindowLeft": { "type": "number", "description": "The distance from the left edge of the client area to the left edge of the window, in unit of point.\n ", "format": "double" }, "WindowTop": { "type": "number", "description": "The distance from the top edge of the client area to the top edge of the window, in unit of point.\n ", "format": "double" }, "WindowWidth": { "type": "number", "description": "The width of the window, in unit of point.\n ", "format": "double" }, "Author": { "type": "string", "description": "Gets and sets the author of the file.\n " }, "CheckCustomNumberFormat": { "type": "boolean", "description": "Indicates whether checking custom number format when setting Style.Custom.\n " }, "ProtectionType": { "type": "string", "description": "Gets the protection type of the workbook.\n " }, "GlobalizationSettings": { "description": "Gets and sets the globalization settings.\n ", "allOf": [ {} ], "$ref": "#/definitions/GlobalizationSettings" }, "Password": { "type": "string", "description": "Represents Workbook file encryption password.\n " }, "WriteProtection": { "description": "Provides access to the workbook write protection options.\n ", "allOf": [ {} ], "$ref": "#/definitions/WriteProtection" }, "IsEncrypted": { "type": "boolean", "description": "Gets a value that indicates whether a password is required to open this workbook.\n " }, "IsProtected": { "type": "boolean", "description": "Gets a value that indicates whether the structure or window of the Workbook is protected.\n " }, "MaxRow": { "type": "integer", "description": "Gets the max row index, zero-based.\n ", "format": "int32" }, "MaxColumn": { "type": "integer", "description": "Gets the max column index, zero-based.\n ", "format": "int32" }, "SignificantDigits": { "type": "integer", "description": "Gets and sets the number of significant digits.\n The default value is .\n ", "format": "int32" }, "CheckCompatibility": { "type": "boolean", "description": "Indicates whether check compatibility with earlier versions when saving workbook.\n " }, "PaperSize": { "type": "string", "description": "Gets and sets the default print paper size.\n " }, "MaxRowsOfSharedFormula": { "type": "integer", "description": "Gets and sets the max row number of shared formula.\n ", "format": "int32" }, "Compliance": { "type": "string", "description": "Specifies the OOXML version for the output document. The default value is Ecma376_2006.\n " }, "QuotePrefixToStyle": { "type": "boolean", "description": "Indicates whether setting property when entering the string value(which starts with single quote mark ) to the cell\n " }, "FormulaSettings": { "description": "Gets the settings for formula-related features.\n ", "allOf": [ {} ], "$ref": "#/definitions/FormulaSettings" }, "ForceFullCalculate": { "type": "boolean", "description": "Fully calculates every time when a calculation is triggered.\n " } } }, "GlobalizationSettings": { "type": "object", "description": "Represents the globalization settings.\n ", "additionalProperties": false, "properties": { "ChartSettings": { "description": "Gets or sets the globalization settings for Chart.\n ", "allOf": [ {} ], "$ref": "#/definitions/ChartGlobalizationSettings" }, "PivotSettings": { "description": "Gets or sets the globalization settings for pivot table.\n ", "allOf": [ {} ], "$ref": "#/definitions/PivotGlobalizationSettings" }, "ListSeparator": { "type": "string", "description": "Gets the separator for list, parameters of function, ...etc.\n " }, "RowSeparatorOfFormulaArray": { "type": "string", "description": "Gets the separator for rows in array data in formula.\n " }, "ColumnSeparatorOfFormulaArray": { "type": "string", "description": "Gets the separator for the items in array's row data in formula.\n " } } }, "ChartGlobalizationSettings": { "type": "object", "description": "Represents the globalization settings for chart.\n ", "additionalProperties": false }, "PivotGlobalizationSettings": { "type": "object", "description": "Represents the globalization settings for pivot tables.\n ", "additionalProperties": false }, "WriteProtection": { "type": "object", "description": "Specifies write protection settings for a workbook.\n ", "additionalProperties": false, "properties": { "Author": { "type": "string", "description": "Gets and sets the author.\n " }, "RecommendReadOnly": { "type": "boolean", "description": "Indicates if the Read Only Recommended option is selected.\n " }, "IsWriteProtected": { "type": "boolean", "description": "Indicates whether this workbook is write protected.\n " }, "Password": { "type": "string", "description": "Sets the protected password to modify the file.\n " } } }, "FormulaSettings": { "type": "object", "description": "Settings of formulas and calculation.\n ", "additionalProperties": false, "properties": { "CalculateOnOpen": { "type": "boolean", "description": "Indicates whether the application is required to perform a full calculation when the workbook is opened.\n " }, "CalculateOnSave": { "type": "boolean", "description": "Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.\n " }, "ForceFullCalculation": { "type": "boolean", "description": "Indicates whether calculates all formulas every time when a calculation is triggered.\n " }, "CalculationMode": { "type": "string", "description": "Gets or sets the mode for workbook calculation in ms excel.\n " }, "CalculationId": { "type": "string", "description": "Specifies the version of the calculation engine used to calculate values in the workbook.\n " }, "EnableIterativeCalculation": { "type": "boolean", "description": "Indicates whether enable iterative calculation to resolve circular references.\n " }, "MaxIteration": { "type": "integer", "description": "The maximum iterations to resolve a circular reference.\n ", "format": "int32" }, "MaxChange": { "type": "number", "description": "The maximum change to resolve a circular reference.\n ", "format": "double" }, "PrecisionAsDisplayed": { "type": "boolean", "description": "Whether the precision of calculated result be set as they are displayed while calculating formulas\n " }, "EnableCalculationChain": { "type": "boolean", "description": "Whether enable calculation chain for formulas. Default is false.\n " }, "PreservePaddingSpaces": { "type": "boolean", "description": "Indicates whether preserve those spaces and line breaks that are padded between formula tokens\n while getting and setting formulas.\n Default value is false.\n " } } }, "TextWaterMarkerRequest": { "type": "object", "description": "Indicates text water marker request.", "additionalProperties": false, "properties": { "Text": { "type": "string", "description": "A property named Text of type string that can be accessed and modified." }, "FontName": { "type": "string", "description": "Indicates font name." }, "FontSize": { "type": "integer", "description": "Indicates font size.", "format": "int32" }, "Height": { "type": "integer", "description": "Indicates image height.", "format": "int32" }, "Width": { "type": "integer", "description": "Indicates image width.", "format": "int32" }, "ImageAdaptOption": { "type": "string" } } }, "WorksheetsResponse": { "type": "object", "description": " Represents the Worksheets Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Worksheets Response.\n ", "additionalProperties": false, "properties": { "Worksheets": { "description": "Property `Worksheets` of type `Worksheets` with the XML element name \"worksheets\" is defined in the class.", "allOf": [ {} ], "$ref": "#/definitions/Worksheets" } } } ] }, "Worksheets": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "properties": { "WorksheetList": { "type": "array", "description": "A property named \"WorksheetList\" that contains a list of elements with the XML element name \"worksheet\".", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "WorksheetMovingRequest": { "type": "object", "description": "Used by workbook moving requests.", "additionalProperties": false, "properties": { "DestinationWorksheet": { "type": "string", "description": "Destination worksheet name. " }, "Position": { "type": "string", "description": "Position to move. Can be BEFORE or AFTER." } } }, "ProtectSheetParameter": { "type": "object", "description": "Class Summary: The features discussed include natural language processing, image recognition, data visualization, clustering, regression, classification, and recommendation systems.", "additionalProperties": false, "properties": { "ProtectionType": { "type": "string", "description": "Property Summary: Defines a public string property for the ProtectionType." }, "Password": { "type": "string" }, "AllowEditArea": { "type": "array", "items": { "type": "string" } }, "AllowDeletingColumn": { "type": "string" }, "AllowDeletingRow": { "type": "string" }, "AllowFiltering": { "type": "string" }, "AllowFormattingCell": { "type": "string" }, "AllowFormattingColumn": { "type": "string" }, "AllowFormattingRow": { "type": "string" }, "AllowInsertingColumn": { "type": "string" }, "AllowInsertingHyperlink": { "type": "string" }, "AllowInsertingRow": { "type": "string" }, "AllowSelectingLockedCell": { "type": "string" }, "AllowSelectingUnlockedCell": { "type": "string" }, "AllowSorting": { "type": "string" }, "AllowUsingPivotTable": { "type": "string" } } }, "CommentsResponse": { "type": "object", "description": " Represents the Comments Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Comments Response.\n ", "additionalProperties": false, "properties": { "Comments": { "description": "Property Summary: \"The Comments property represents an XML element named 'comments' within the class.\"", "allOf": [ {} ], "$ref": "#/definitions/Comments" } } } ] }, "Comments": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "properties": { "CommentList": { "type": "array", "description": "Property Summary: The CommentList property is annotated to be serialized as XML elements under the tag \"comment\" and holds a collection of LinkElement objects.", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "CommentResponse": { "type": "object", "description": " Represents the Comment Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Comment Response.\n ", "additionalProperties": false, "properties": { "Comment": { "description": "The class has a public property \"Comment\" of type \"Comment\" that can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/Comment" } } } ] }, "Comment": { "type": "object", "description": " Encapsulates the object that represents a cell comment.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Encapsulates the object that represents a cell comment.\n ", "additionalProperties": false, "properties": { "CellName": { "type": "string", "description": "Property: CellName attribute with XmlElement tag in the class." }, "Author": { "type": "string", "description": "Gets and sets Name of the original comment author\n " }, "HtmlNote": { "type": "string", "description": "Gets and sets the html string which contains data and some formats in this comment.\n " }, "Note": { "type": "string", "description": "Represents the content of comment.\n " }, "AutoSize": { "type": "boolean", "description": "Indicates if size of comment is adjusted automatically according to its content.\n " }, "IsVisible": { "type": "boolean", "description": "Represents if the comment is visible or not.\n " }, "Width": { "type": "integer", "description": "Represents the width of the comment, in unit of pixels.\n ", "format": "int32" }, "Height": { "type": "integer", "description": "Represents the Height of the comment, in unit of pixels.\n ", "format": "int32" }, "TextHorizontalAlignment": { "type": "string", "description": "Gets and sets the text horizontal alignment type of the comment.\n " }, "TextOrientationType": { "type": "string", "description": "Gets and sets the text orientation type of the comment.\n " }, "TextVerticalAlignment": { "type": "string", "description": "Gets and sets the text vertical alignment type of the comment.\n " } } } ] }, "MergedCellsResponse": { "type": "object", "description": " Represents the MergedCells Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the MergedCells Response.\n ", "additionalProperties": false, "properties": { "MergedCells": { "description": "Property Summary: Contains information about merged cells within a spreadsheet.", "allOf": [ {} ], "$ref": "#/definitions/MergedCells" } } } ] }, "MergedCells": { "type": "object", "description": "Sure, could you please provide me with the features you would like me to summarize?", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Sure, could you please provide me with the features you would like me to summarize?", "additionalProperties": false, "required": [ "Count" ], "properties": { "Count": { "type": "integer", "description": "An integer property labeled as \"count\" and marked as an XML element in the class.", "format": "int32" }, "MergedCellList": { "type": "array", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "MergedCellResponse": { "type": "object", "description": " Represents the MergedCell Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the MergedCell Response.\n ", "additionalProperties": false, "properties": { "MergedCell": { "description": "A property named \"MergedCell\" of type \"MergedCell\" which allows getting and setting its value.", "allOf": [ {} ], "$ref": "#/definitions/MergedCell" } } } ] }, "MergedCell": { "type": "object", "description": "I'm happy to help! Could you please provide me with the features you would like me to summarize for the class?", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "I'm happy to help! Could you please provide me with the features you would like me to summarize for the class?", "additionalProperties": false, "required": [ "EndColumn", "EndRow", "StartColumn", "StartRow" ], "properties": { "EndColumn": { "type": "integer", "description": "An integer property named \"EndColumn\" with the XML element name \"endcolumn\".", "format": "int32" }, "EndRow": { "type": "integer", "format": "int32" }, "StartColumn": { "type": "integer", "format": "int32" }, "StartRow": { "type": "integer", "format": "int32" } } } ] }, "SingleValueResponse": { "type": "object", "description": " Represents the SingleValue Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the SingleValue Response.\n ", "additionalProperties": false, "properties": { "Value": { "description": "A property named \"Value\" of type \"SingleValue\" that can be accessed and modified is declared in the class.", "allOf": [ {} ], "$ref": "#/definitions/SingleValue" } } } ] }, "SingleValue": { "type": "object", "description": "Represents single value.", "additionalProperties": false, "properties": { "Value": { "type": "string", "description": "Represents value." }, "ValueType": { "description": "Represents value type.", "allOf": [ {} ], "$ref": "#/definitions/ValueType" } } }, "ValueType": { "type": "object", "x-abstract": true, "additionalProperties": false }, "WorksheetReplaceResponse": { "type": "object", "description": " Represents the WorksheetReplace Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the WorksheetReplace Response.\n ", "additionalProperties": false, "required": [ "Matches" ], "properties": { "Matches": { "type": "integer", "description": "\"An integer property named Matches decorated with the XmlElement attribute.\"", "format": "int32" }, "Worksheet": { "$ref": "#/definitions/LinkElement" } } } ] }, "CopyOptions": { "type": "object", "description": "Represents the copy options.", "additionalProperties": false, "properties": { "ColumnCharacterWidth": { "type": "boolean", "description": "Indicates whether copying column width in unit of characters.\n " }, "CopyInvalidFormulasAsValues": { "type": "boolean", "description": "If the formula is not valid for the dest destination, only copy values.\n " }, "CopyNames": { "type": "boolean", "description": "Indicates whether copying the names.\n " }, "ExtendToAdjacentRange": { "type": "boolean", "description": "Indicates whether extend ranges when copying the range to adjacent range.\n " }, "ReferToDestinationSheet": { "type": "boolean", "description": "When copying the range in the same file and the chart refers to the source sheet,\n False means the copied chart's data source will not be changed.\n True means the copied chart's data source refers to the destination sheet.\n " }, "ReferToSheetWithSameName": { "type": "boolean", "description": "In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one,\n the copied formulas should refer to source workbook.\n However, for some situations user may need the copied formulas refer to worksheets with the same name\n in the same workbook, such as when those worksheets have been copied before this copy operation,\n then this property should be kept as true.\n " }, "CopyTheme": { "type": "boolean" } } }, "Worksheet": { "type": "object", "description": " Encapsulates the object that represents a single worksheet.\n ", "additionalProperties": false, "required": [ "Index", "IsProtected" ], "properties": { "Links": { "type": "array", "description": "Property Summary: Contains a list of links represented by the class link.", "items": { "$ref": "#/definitions/Link" } }, "DisplayRightToLeft": { "type": "boolean", "description": "Indicates if the specified worksheet is displayed from right to left instead of from left to right.\n Default is false.\n " }, "DisplayZeros": { "type": "boolean", "description": "True if zero values are displayed.\n " }, "FirstVisibleColumn": { "type": "integer", "description": "Represents first visible column index.\n ", "format": "int32" }, "FirstVisibleRow": { "type": "integer", "description": "Represents first visible row index.\n ", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the worksheet.\n " }, "Index": { "type": "integer", "description": "Gets the index of sheet in the worksheet collection.\n ", "format": "int32" }, "IsGridlinesVisible": { "type": "boolean", "description": "Gets or sets a value indicating whether the gridlines are visible.Default is true.\n " }, "IsOutlineShown": { "type": "boolean", "description": "Indicates whether to show outline.\n " }, "IsPageBreakPreview": { "type": "boolean", "description": "Indicates whether the specified worksheet is shown in normal view or page break preview.\n " }, "IsVisible": { "type": "boolean", "description": "Represents if the worksheet is visible.\n " }, "IsProtected": { "type": "boolean", "description": "Indicates if the worksheet is protected.\n " }, "IsRowColumnHeadersVisible": { "type": "boolean", "description": "Gets or sets a value indicating whether the worksheet will display row and column headers.\n Default is true.\n " }, "IsRulerVisible": { "type": "boolean", "description": "Indicates whether the ruler is visible. This property is only applied for page break preview.\n " }, "IsSelected": { "type": "boolean", "description": "Indicates whether this worksheet is selected when the workbook is opened.\n " }, "TabColor": { "description": "Represents worksheet tab color.\n ", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "TransitionEntry": { "type": "boolean", "description": "Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.\n " }, "TransitionEvaluation": { "type": "boolean", "description": "Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.\n " }, "Type": { "type": "string", "description": "Represents worksheet type.\n " }, "ViewType": { "type": "string", "description": "Gets and sets the view type.\n " }, "VisibilityType": { "type": "string", "description": "Indicates the visible state for this sheet.\n " }, "Zoom": { "type": "integer", "description": "Represents the scaling factor in percentage. It should be between 10 and 400.\n ", "format": "int32" }, "Cells": { "description": "Gets the collection.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Charts": { "description": "Gets a collection\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "AutoShapes": { "$ref": "#/definitions/LinkElement" }, "OleObjects": { "description": "Represents a collection of in a worksheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Comments": { "description": "Gets the collection.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Pictures": { "description": "Gets a collection.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "MergedCells": { "$ref": "#/definitions/LinkElement" }, "Validations": { "description": "Gets the data validation setting collection in the worksheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "ConditionalFormattings": { "description": "Gets the ConditionalFormattings in the worksheet.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" }, "Hyperlinks": { "description": "Gets the collection.\n ", "allOf": [ {} ], "$ref": "#/definitions/LinkElement" } } }, "RangesResponse": { "type": "object", "description": " Represents the Ranges Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Ranges Response.\n ", "additionalProperties": false, "properties": { "Ranges": { "description": "This class has a property named \"Ranges\" of type \"Ranges\" that can be accessed and modified.", "allOf": [ {} ], "$ref": "#/definitions/Ranges" } } } ] }, "Ranges": { "type": "object", "description": " Encapsulates a collection of objects.\n ", "additionalProperties": false, "properties": { "RangeList": { "type": "array", "description": "Property Summary: Contains a list of ranges specified by the XmlElement \"Range\".", "items": { "$ref": "#/definitions/Range" } } } }, "ValidationsResponse": { "type": "object", "description": " Represents the Validations Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Validations Response.\n ", "additionalProperties": false, "properties": { "Validations": { "description": "This class has a public property named \"Validations\" of type \"Validations\" that includes both a getter and a setter.", "allOf": [ {} ], "$ref": "#/definitions/Validations" } } } ] }, "Validations": { "type": "object", "description": " Represents data validation collection.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents data validation collection.\n ", "additionalProperties": false, "required": [ "Count" ], "properties": { "Count": { "type": "integer", "description": "Property summary: The property \"Count\" with an XML element name \"count\" returns the number of items in the \"ValidationList\".", "format": "int32" }, "ValidationList": { "type": "array", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "ValidationResponse": { "type": "object", "description": " Represents the Validation Response.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CellsCloudResponse" }, { "type": "object", "description": " Represents the Validation Response.\n ", "additionalProperties": false, "properties": { "Validation": { "description": "The class has a public property for Validation.", "allOf": [ {} ], "$ref": "#/definitions/Validation" } } } ] }, "Validation": { "type": "object", "description": " Represents data validation.settings.\n ", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": " Represents data validation.settings.\n ", "additionalProperties": false, "properties": { "AlertStyle": { "type": "string", "description": "Represents the validation alert style.\n " }, "AreaList": { "type": "array", "description": "Represents a collection of Aspose.Cells.CellArea which contains the data\n validation settings.", "items": { "$ref": "#/definitions/CellArea" } }, "ErrorMessage": { "type": "string", "description": "Represents the data validation error message.\n " }, "ErrorTitle": { "type": "string", "description": "Represents the title of the data-validation error dialog box.\n " }, "Formula1": { "type": "string", "description": "Represents the value or expression associated with the data validation.\n " }, "Formula2": { "type": "string", "description": "Represents the value or expression associated with the data validation.\n " }, "IgnoreBlank": { "type": "boolean", "description": "Indicates whether blank values are permitted by the range data validation.\n " }, "InCellDropDown": { "type": "boolean", "description": "Indicates whether data validation displays a drop-down list that contains acceptable values.\n " }, "InputMessage": { "type": "string", "description": "Represents the data validation input message.\n " }, "InputTitle": { "type": "string", "description": "Represents the title of the data-validation input dialog box.\n " }, "Operator": { "type": "string", "description": "Represents the operator for the data validation.\n " }, "ShowError": { "type": "boolean", "description": "Indicates whether the data validation error message will be displayed whenever the user enters invalid data.\n " }, "ShowInput": { "type": "boolean", "description": "Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.\n " }, "Type": { "type": "string", "description": "Represents the data validation type.\n " }, "Value1": { "type": "string", "description": "Represents the first value associated with the data validation.\n " }, "Value2": { "type": "string", "description": "Represents the second value associated with the data validation.\n " } } } ] } }, "securityDefinitions": { "JWT": { "type": "oauth2", "flow": "application", "tokenUrl": "https://api.aspose.cloud/connect/token" } } }