RetrieveWorkbookSheets

DatasourceService / RetrieveWorkbookSheets

Description: Get workbooksheet

URL: http://{your-server-url}/api/v1/core/datasources/workbooks/instances/{instanceid}/workbook/sheets

Method: GET

Token Required: True

Request Headers:

content-type: application/json or content-type: application/xml
token: {token}
currentaccountid: {accountid - optional and default value is user's own account}

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator, Widget Manager

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right	Require
Widget_Management	Yes
Application_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500
sheetnames	int[]	True	comma separated values, eg. sheetnames=sheet1,sheet%20name. Space (' ') need to be replace by %20

Example: http://{your-server-url}/api/v1/core/datasources/workbooks/instances/{instanceid}/workbook/sheets?page=100&rpp=100&sheetnames=1,2,3

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource.DatasourceResponse

Parameter	Type
Response.WorkbookSheets	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Workbook.WorkbookSheet[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

The following is an example response Xml body:

<DatasourceResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
  <WorkbookSheets xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Workbook">
    <a:WorkbookSheet>
      <a:Data>String</a:Data>
      <a:Name>String</a:Name>
    </a:WorkbookSheet>
  </WorkbookSheets>
</DatasourceResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123,
	"WorkbookSheets":[
		{
			"Data":"String",
			"Name":"String"
		}
	]
}