Update Global Datasource
/essbase/rest/v1/datasources/{datasourceName}
Update the named global-level Datasource. If the update is successful, returns details about the updated Datasource. type and connection are required inputs for all types of Datasources. Other required inputs differ based on the type of the Datasource.
Request
- application/json
- application/xml
-
datasourceName: string
Datasource name.
Updated Datasource details.
object-
application:
string
Applicable if the type of Datasource is ESSBASE. The Essbase application name.
-
columns:
object ColumnsType
-
connection:
string
Connection used for this Datasource.
-
cube:
string
Applicable if the type of Datasource is ESSBASE. The Essbase database name.
-
customDelimiter(optional):
string
Custom delimiter of the data records, if the value provided for delimiter is
Custom. -
delimeter(optional):
string
Delimiter of the data records, if Datasource type is
DELIMITEDFILE. Delimiter can beCommafor CSV format orTabfor tab-separated format. To use a custom delimiter, use valueCustom, and provide the delimiter as a value to customDelimiter. -
description:
string
Optional description of this Datasource.
-
endRow(optional):
integer(int64)
For a Datasource that is an Excel or text file, the ending row number.
-
headerRow(optional):
integer(int64)
For a Datasource that is an Excel or text file, the header row number. 0 if there is no header.
-
headers(optional):
array headers
-
ignoreErrorRecords(optional):
boolean
-
links(optional):
array links
-
name(optional):
string
Datasource name. Must begin with a letter. Can contain only letters, underscore character, and digits.
-
query:
string
Query associated with the Datasource. For example, a SQL query for an external database, or an MDX query for another Essbase cube. The query selects which data you want to make available in this Datasource.
-
queryParameters(optional):
array queryParameters
Parameter implementation details, if the Datasource query is parameterized. For example, if the query includes a
?placeholder for passing a parameter, as in the following query:select * from profit_data where year=?, then you need define the implementation details. -
sheet:
string
For a Datasource that is an Excel file, the worksheet name.
-
skipHiddenRows(optional):
boolean
-
startRow:
integer(int64)
Optional (default is 1 if not given). For a Datasource that is an Excel or text file, the starting data row number, excluding headerRow if one exists. For example, if headerRow is specified as 1 and startRow is specified as 10, the actual starting data row will be 11.
-
type:
string
Allowed Values:
[ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ] -
widths:
array widths
arrayParameter implementation details, if the Datasource query is parameterized. For example, if the query includes a ? placeholder for passing a parameter, as in the following query: select * from profit_data where year=?, then you need define the implementation details.
object-
format(optional):
string
-
index(optional):
integer(int32)
-
name(optional):
string
-
nullable(optional):
boolean
-
system(optional):
boolean
-
type(optional):
string
Allowed Values:
[ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]
object-
defaultValue(optional):
string
A fixed, default parameter value that the Datasource should use as a fallback in case the parameter has an invalid context at runtime. Example: Jan. Required only if the Datasource query is parameterized (it includes a
?placeholder for passing a parameter) AND the placeholder is not intended to reference a substitution variable nor a user-defined function developed in the external source. -
index(optional):
integer(int32)
Ordinal index of the Datasource query parameter. For example, 1 for the first parameter, 2 for the second parameter, etc.
-
name(optional):
string
Optional name for the Datasource query parameter, meaningful for your use case. For example, instead of Param1 you can use param_G_month to indicate that the parameter uses a global variable for the current month, or you can rename it to param_appName_month to indicate that the parameter uses an application-level variable for the current month.
-
required(optional):
boolean
true if the Datasource query parameter is required, or false otherwise.
-
subVariableName(optional):
string
If useSubVariable is true, the name of an Essbase substitution variable.
-
type(optional):
string
Allowed Values:
[ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]Datatype of the Datasource query parameter.
-
useSubVariable(optional):
boolean
true if the Datasource query parameter references an Essbase substitution variable, or false otherwise.
Response
- application/json
- application/xml
200 Response
OK
Datasource was updated successfully.
object-
application:
string
Applicable if the type of Datasource is ESSBASE. The Essbase application name.
-
columns:
object ColumnsType
-
connection:
string
Connection used for this Datasource.
-
cube:
string
Applicable if the type of Datasource is ESSBASE. The Essbase database name.
-
customDelimiter(optional):
string
Custom delimiter of the data records, if the value provided for delimiter is
Custom. -
delimeter(optional):
string
Delimiter of the data records, if Datasource type is
DELIMITEDFILE. Delimiter can beCommafor CSV format orTabfor tab-separated format. To use a custom delimiter, use valueCustom, and provide the delimiter as a value to customDelimiter. -
description:
string
Optional description of this Datasource.
-
endRow(optional):
integer(int64)
For a Datasource that is an Excel or text file, the ending row number.
-
headerRow(optional):
integer(int64)
For a Datasource that is an Excel or text file, the header row number. 0 if there is no header.
-
headers(optional):
array headers
-
ignoreErrorRecords(optional):
boolean
-
links(optional):
array links
-
name(optional):
string
Datasource name. Must begin with a letter. Can contain only letters, underscore character, and digits.
-
query:
string
Query associated with the Datasource. For example, a SQL query for an external database, or an MDX query for another Essbase cube. The query selects which data you want to make available in this Datasource.
-
queryParameters(optional):
array queryParameters
Parameter implementation details, if the Datasource query is parameterized. For example, if the query includes a
?placeholder for passing a parameter, as in the following query:select * from profit_data where year=?, then you need define the implementation details. -
sheet:
string
For a Datasource that is an Excel file, the worksheet name.
-
skipHiddenRows(optional):
boolean
-
startRow:
integer(int64)
Optional (default is 1 if not given). For a Datasource that is an Excel or text file, the starting data row number, excluding headerRow if one exists. For example, if headerRow is specified as 1 and startRow is specified as 10, the actual starting data row will be 11.
-
type:
string
Allowed Values:
[ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ] -
widths:
array widths
arrayParameter implementation details, if the Datasource query is parameterized. For example, if the query includes a ? placeholder for passing a parameter, as in the following query: select * from profit_data where year=?, then you need define the implementation details.
object-
format(optional):
string
-
index(optional):
integer(int32)
-
name(optional):
string
-
nullable(optional):
boolean
-
system(optional):
boolean
-
type(optional):
string
Allowed Values:
[ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]
object-
defaultValue(optional):
string
A fixed, default parameter value that the Datasource should use as a fallback in case the parameter has an invalid context at runtime. Example: Jan. Required only if the Datasource query is parameterized (it includes a
?placeholder for passing a parameter) AND the placeholder is not intended to reference a substitution variable nor a user-defined function developed in the external source. -
index(optional):
integer(int32)
Ordinal index of the Datasource query parameter. For example, 1 for the first parameter, 2 for the second parameter, etc.
-
name(optional):
string
Optional name for the Datasource query parameter, meaningful for your use case. For example, instead of Param1 you can use param_G_month to indicate that the parameter uses a global variable for the current month, or you can rename it to param_appName_month to indicate that the parameter uses an application-level variable for the current month.
-
required(optional):
boolean
true if the Datasource query parameter is required, or false otherwise.
-
subVariableName(optional):
string
If useSubVariable is true, the name of an Essbase substitution variable.
-
type(optional):
string
Allowed Values:
[ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]Datatype of the Datasource query parameter.
-
useSubVariable(optional):
boolean
true if the Datasource query parameter references an Essbase substitution variable, or false otherwise.
400 Response
Bad Request
Failed to update the Datasource.
Examples
The following example shows how to update an existing global Datasource.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.
Script with cURL Command
call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/datasources/EssbaseDS?links=none" -H Accept:application/json -H Content-Type:application/json --data "@./updateDSessbase.json" -u %User%:%Password%The cURL example above delivers a JSON payload in updateDSessbase.json. The details you need to include in the payload depend on what type of Datasource you are updating. The example below is for updating an Essbase Datasource.
Sample JSON Payload - Essbase Datasource
The following sample JSON payload, passed to REST API in updateDSessbase.json, is an example for updating a Datasource for another Essbase cube. The required parameters are The required parameters are name, connection, type, columns, application, cube, and query.
{
"name":"EssbaseDS",
"type":"ESSBASE",
"connection":"essconn",
"columns":{
"Column":[
{
"index":1,
"name":"Measures",
"type":"STRING"
},
{
"index":2,
"name":"Oregon",
"type":"STRING"
},
{
"index":3,
"name":"California",
"type":"STRING"
},
{
"index":4,
"name":"Utah",
"type":"STRING"
}]
},
"query":"select {COGS} on rows ,{Oregon, California, Utah} on columns",
"application":"Sample",
"cube":"Basic"
}For more examples of JSON payloads you can use to test, update, and create Datasources for sources supported by Essbase, see the Create Datasource endpoint.
Example of Response Body - Essbase Datasource
The following example shows the contents of the response body in JSON format.
{
"name" : "EssbaseDS",
"connection" : "essconn",
"type" : "ESSBASE",
"columns" : {
"Column" : [ {
"name" : "Measures",
"type" : "STRING",
"index" : 1,
"system" : false
}, {
"name" : "Oregon",
"type" : "STRING",
"index" : 2,
"system" : false
}, {
"name" : "California",
"type" : "STRING",
"index" : 3,
"system" : false
}, {
"name" : "Utah",
"type" : "STRING",
"index" : 4,
"system" : false
} ]
},
"query" : "select {COGS} on rows ,{Oregon, California, Utah} on columns",
"application" : "Sample",
"cube" : "Basic",
"queryParameters" : [ ],
"links" : [ ]
}