Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

Name

Type

Mandatory

Comment

Name

String

Yes

The name of a table. This string cannot be longer than 25 characters.

Note: Underscores in the name are not supported.

Public

Boolean

No

Indicates if the table should be publicly visible. True by default.

Schema

String

Yes

Protocol to use for communicating with a data source endpoint. "Http" or "Https".

Method

String

Yes

HTTP request methods to use. "GET" or "POST".

Base

String

Yes

Data source's REST API endpoint URL.

Path

String

Yes

URI of a resource that the table represents. This value is defined relative to the Base value.

Headers

Object

Yes

String -> String key-value pairs required by the REST service provider. These key-value pairs are typically information you need to provide the RESTful service, but do not want to expose in the URL of the request, for example authentication details.

Anchor
accummset
accummset
AccumulativeSettings
ObjectNo

This object contains keys whose values define the starting point for your accumulative builds.

Accumulative Builds are supported only for connectors that support them and for integer and datetime fields.

Within the AccumaltiveSettings object, there are two keys that you can define.

DefaultValue: (Mandatory) Defines the starting point for the build. The first time you must define this value, and for each subsequent build, Sisense updates this value automatically. This can be an integer or datetime value. DateTimeFormat:(Optional) When the DefaultValue is a datetime field, this key defines the format for the DefaultValue. Click here for formatting examples.

This object should only be defined when using the [@accumulative] InMemory parameter within the same table. For each table that you want to support accumulative builds, you must include the [@accumulative] reference and the AccumulativeSettings object.   For more information about InMemory parameters, click here.

PathParameters

Array

Yes

List of strings of path parameters. For more information, click here.

QueryParameters

Object

No

String -> String key-value pairs for specifying query parameters in URL query string.

ArrayQueryParameters

Object

No

String -> array key-value pairs, used for handling arrays in URL query string.

Body

Object

No

HTTP request body.

Anchor
post
post

Anchor
post
post

Sisense supports using nested objects with the Body object for HTTP Post requests.

For example:

"Body": {

 "credentials": {
  "username": "MyUser",
  "password": "MyPassword",
  "company": "123456"
    }
}

Some data sources require parameters represented as JSON objects, such as credentials stored in objects as shown in the example above.

BodyXml

String

No

When the data source expects XML, set the content as the value of BodyXml and leave the Body object empty.

As the data source provider expects XML, the value of BodyXml should be in XML format, not JSON.

The string should be inside double qoutes “ “ as displayed in the example below:

"BodyXml": "<xml><credentials><username>MyUser</username></credentials></xml>"
"

DataFormat

String

No

Format of a source data. The only supported value is "Json".

AllowDuplicateElementNamesBooleanNoSome REST sources return duplicate elements and this may trigger an error. If you receive a Duplicate Name error, set include this value and set it as true to prevent the error and return the full response as expected. Do not include this key:value pair unless you receive the Duplicate Name error as it can decrease performance.
ValidateJsonPropertyNameBooleanNoTo prevent recieving

Set to true if you receive the error message below. This is caused by unsupported element names according to the JSON standard, such as elements that begin with '.' or '$'

,

. When you set this key to true

and

, Sisense will convert these symbols to underscores, '_' when importing them into Sisense.

Image Added

Transformation

Transformation

No

Transformation object. For more information, click here.

PagingConfig

PagingConfig

No

Data pagination configuration.

ResponseFormatStringNo Defines the type of response to be returned from the data source provider to Sisense. Sisense currently accepts JSON (default), CSV, and XML.
CookiesStringNo

When a data source provides cookies in a response to your initial request, this value defines where the cookies are to be sent back to the provider.

For example:

"Cookies": "[@[email protected]~Cookies]",

In this example, the data source returns the cookie as the value of Cookies inside the Auth object. This value can then be sent to the data source provider in future requests.

CsvHeaderBooleanNoWhen True, returns the Header of content of a CSV.   

DataPath

String

Yes

The name of the top level key containing the data set. For more information see DataPath.  

 

...