Package com.seeq.api
Class FormulasApi
java.lang.Object
com.seeq.api.FormulasApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionClear all formula cachesclearCacheWithHeadersAndHttpInfo
(Map<String, String> customHeaders) Clear all formula cachesClear all formula cachescompileFormula
(String formula, List<String> parameters) Compile a Seeq FormulacompileFormulaWithHeadersAndHttpInfo
(String formula, List<String> parameters, Map<String, String> customHeaders) Compile a Seeq FormulacompileFormulaWithHttpInfo
(String formula, List<String> parameters) Compile a Seeq FormulaCreate a functioncreateFunctionWithHeadersAndHttpInfo
(FunctionInputV1 body, Map<String, String> customHeaders) Create a functionCreate a functioncreateItem
(FormulaItemInputV1 body) Create a formula itemcreateItemWithHeadersAndHttpInfo
(FormulaItemInputV1 body, Map<String, String> customHeaders) Create a formula itemCreate a formula itemdeleteFormulaDoc
(String packageName, String docName) Permanently delete the specified formula docdeleteFormulaDocWithHeadersAndHttpInfo
(String packageName, String docName, Map<String, String> customHeaders) Permanently delete the specified formula docdeleteFormulaDocWithHttpInfo
(String packageName, String docName) Permanently delete the specified formula docdeletePackage
(String packageName) Permanently delete a specific packagedeletePackageWithHeadersAndHttpInfo
(String packageName, Map<String, String> customHeaders) Permanently delete a specific packagedeletePackageWithHttpInfo
(String packageName) Permanently delete a specific packageGet a list of the constants available for use in a calculationgetConstantNameListWithHeadersAndHttpInfo
(Map<String, String> customHeaders) Get a list of the constants available for use in a calculationGet a list of the constants available for use in a calculationgetFormulaDoc
(String packageName, String docName) Get documentation details about a specific function group or indexGet a list of the functions available for use in a calculationgetFormulaDocsWithHeadersAndHttpInfo
(Map<String, String> customHeaders) Get a list of the functions available for use in a calculationGet a list of the functions available for use in a calculationgetFormulaDocWithHeadersAndHttpInfo
(String packageName, String docName, Map<String, String> customHeaders) Get documentation details about a specific function group or indexgetFormulaDocWithHttpInfo
(String packageName, String docName) Get documentation details about a specific function group or indexgetFormulaFunctions
(String type, Integer offset, Integer limit) Get a collection of Formula FunctionsgetFormulaFunctionsWithHeadersAndHttpInfo
(String type, Integer offset, Integer limit, Map<String, String> customHeaders) Get a collection of Formula FunctionsgetFormulaFunctionsWithHttpInfo
(String type, Integer offset, Integer limit) Get a collection of Formula FunctionsgetFunction
(String id) Get a Formula FunctiongetFunctionWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a Formula FunctionGet a Formula FunctionGet a Formula ItemgetItemWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a Formula ItemGet a Formula ItemgetPackage
(String packageName) Get details of a specific packagegetPackages
(Integer offset, Integer limit) Get a collection of packagesGet a collection of packagesgetPackagesWithHttpInfo
(Integer offset, Integer limit) Get a collection of packagesgetPackageWithHeadersAndHttpInfo
(String packageName, Map<String, String> customHeaders) Get details of a specific packagegetPackageWithHttpInfo
(String packageName) Get details of a specific packagelong
Create or update a package of UDFs with documentation.importPackageWithHeadersAndHttpInfo
(FormulaPackageImportInputV1 body, Map<String, String> customHeaders) Create or update a package of UDFs with documentation.Create or update a package of UDFs with documentation.putFormulaDoc
(String packageName, String docName, FormulaDocInputV1 body) Create or update the specified formula docputFormulaDocWithHeadersAndHttpInfo
(String packageName, String docName, FormulaDocInputV1 body, Map<String, String> customHeaders) Create or update the specified formula docputFormulaDocWithHttpInfo
(String packageName, String docName, FormulaDocInputV1 body) Create or update the specified formula docputPackage
(String packageName, FormulaPackageInputV1 body) Create or update a packageputPackageWithHeadersAndHttpInfo
(String packageName, FormulaPackageInputV1 body, Map<String, String> customHeaders) Create or update a packageputPackageWithHttpInfo
(String packageName, FormulaPackageInputV1 body) Create or update a packagerunFormula
(String start, String end, String formula, String function, List<String> parameters, List<String> fragments, String root, String reduceFormula, Integer offset, Integer limit, String timeFormat) Run a Seeq FormulaRun a Seeq Formula.runFormula_0WithHeadersAndHttpInfo
(FormulaRunInputV1 body, Map<String, String> customHeaders) Run a Seeq Formula.Run a Seeq Formula.runFormulaWithHeadersAndHttpInfo
(String start, String end, String formula, String function, List<String> parameters, List<String> fragments, String root, String reduceFormula, Integer offset, Integer limit, String timeFormat, Map<String, String> customHeaders) Run a Seeq FormularunFormulaWithHttpInfo
(String start, String end, String formula, String function, List<String> parameters, List<String> fragments, String root, String reduceFormula, Integer offset, Integer limit, String timeFormat) Run a Seeq Formulavoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) updateFunction
(String id, FunctionInputV1 body) Update a functionupdateFunctionWithHeadersAndHttpInfo
(String id, FunctionInputV1 body, Map<String, String> customHeaders) Update a functionupdateFunctionWithHttpInfo
(String id, FunctionInputV1 body) Update a function
-
Constructor Details
-
FormulasApi
public FormulasApi() -
FormulasApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
clearCache
Clear all formula caches- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
clearCacheWithHttpInfo
Clear all formula caches- Throws:
ApiException
- if fails to make API call
-
clearCacheWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> clearCacheWithHeadersAndHttpInfo(Map<String, String> customHeaders) throws ApiExceptionClear all formula caches- Parameters:
customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
compileFormula
public FormulaCompileOutputV1 compileFormula(String formula, List<String> parameters) throws ApiException Compile a Seeq Formula- Parameters:
formula
- A formula to be applied to the data from the series. The formula should reference the series using the $series variable. Formulas can be used to retrieve an aggregate. Examples: return $series.min(), return $series.sum(). Ignored for numeric (non-time) series. (optional)parameters
- Parameters for the formula. Each parameter should have a format of 'name=id' where 'name' is the variable identifier, without the leading $ sign, and 'id' is the ID of the item referenced by the variable. (optional)- Returns:
- FormulaCompileOutputV1
- Throws:
ApiException
- if fails to make API call
-
compileFormulaWithHttpInfo
public ApiClient.ApiResponse<FormulaCompileOutputV1> compileFormulaWithHttpInfo(String formula, List<String> parameters) throws ApiException Compile a Seeq Formula- Parameters:
formula
- A formula to be applied to the data from the series. The formula should reference the series using the $series variable. Formulas can be used to retrieve an aggregate. Examples: return $series.min(), return $series.sum(). Ignored for numeric (non-time) series. (optional)parameters
- Parameters for the formula. Each parameter should have a format of 'name=id' where 'name' is the variable identifier, without the leading $ sign, and 'id' is the ID of the item referenced by the variable. (optional)- Throws:
ApiException
- if fails to make API call
-
compileFormulaWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaCompileOutputV1> compileFormulaWithHeadersAndHttpInfo(String formula, List<String> parameters, Map<String, String> customHeaders) throws ApiExceptionCompile a Seeq Formula- Parameters:
formula
- A formula to be applied to the data from the series. The formula should reference the series using the $series variable. Formulas can be used to retrieve an aggregate. Examples: return $series.min(), return $series.sum(). Ignored for numeric (non-time) series. (optional)parameters
- Parameters for the formula. Each parameter should have a format of 'name=id' where 'name' is the variable identifier, without the leading $ sign, and 'id' is the ID of the item referenced by the variable. (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createFunction
Create a function- Parameters:
body
- Function information (required)- Returns:
- CalculatedItemOutputV1
- Throws:
ApiException
- if fails to make API call
-
createFunctionWithHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> createFunctionWithHttpInfo(FunctionInputV1 body) throws ApiException Create a function- Parameters:
body
- Function information (required)- Throws:
ApiException
- if fails to make API call
-
createFunctionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> createFunctionWithHeadersAndHttpInfo(FunctionInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a function- Parameters:
body
- Function information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createItem
Create a formula item- Parameters:
body
- Item information (required)- Returns:
- FormulaItemOutputV1
- Throws:
ApiException
- if fails to make API call
-
createItemWithHttpInfo
public ApiClient.ApiResponse<FormulaItemOutputV1> createItemWithHttpInfo(FormulaItemInputV1 body) throws ApiException Create a formula item- Parameters:
body
- Item information (required)- Throws:
ApiException
- if fails to make API call
-
createItemWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaItemOutputV1> createItemWithHeadersAndHttpInfo(FormulaItemInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a formula item- Parameters:
body
- Item information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
deleteFormulaDoc
Permanently delete the specified formula doc- Parameters:
packageName
- The name of the package (required)docName
- The name of the formula doc (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
deleteFormulaDocWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteFormulaDocWithHttpInfo(String packageName, String docName) throws ApiException Permanently delete the specified formula doc- Parameters:
packageName
- The name of the package (required)docName
- The name of the formula doc (required)- Throws:
ApiException
- if fails to make API call
-
deleteFormulaDocWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteFormulaDocWithHeadersAndHttpInfo(String packageName, String docName, Map<String, String> customHeaders) throws ApiExceptionPermanently delete the specified formula doc- Parameters:
packageName
- The name of the package (required)docName
- The name of the formula doc (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
deletePackage
Permanently delete a specific package- Parameters:
packageName
- The name of the package (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
deletePackageWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deletePackageWithHttpInfo(String packageName) throws ApiException Permanently delete a specific package- Parameters:
packageName
- The name of the package (required)- Throws:
ApiException
- if fails to make API call
-
deletePackageWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deletePackageWithHeadersAndHttpInfo(String packageName, Map<String, String> customHeaders) throws ApiExceptionPermanently delete a specific package- Parameters:
packageName
- The name of the package (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getConstantNameList
Get a list of the constants available for use in a calculation- Returns:
- List<String>
- Throws:
ApiException
- if fails to make API call
-
getConstantNameListWithHttpInfo
Get a list of the constants available for use in a calculation- Throws:
ApiException
- if fails to make API call
-
getConstantNameListWithHeadersAndHttpInfo
public ApiClient.ApiResponse<List<String>> getConstantNameListWithHeadersAndHttpInfo(Map<String, String> customHeaders) throws ApiExceptionGet a list of the constants available for use in a calculation- Parameters:
customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getFormulaDoc
Get documentation details about a specific function group or index- Parameters:
packageName
- The name of the package (required)docName
- The name of the document for the desired function or index (required)- Returns:
- FormulaDocOutputV1
- Throws:
ApiException
- if fails to make API call
-
getFormulaDocWithHttpInfo
public ApiClient.ApiResponse<FormulaDocOutputV1> getFormulaDocWithHttpInfo(String packageName, String docName) throws ApiException Get documentation details about a specific function group or index- Parameters:
packageName
- The name of the package (required)docName
- The name of the document for the desired function or index (required)- Throws:
ApiException
- if fails to make API call
-
getFormulaDocWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaDocOutputV1> getFormulaDocWithHeadersAndHttpInfo(String packageName, String docName, Map<String, String> customHeaders) throws ApiExceptionGet documentation details about a specific function group or index- Parameters:
packageName
- The name of the package (required)docName
- The name of the document for the desired function or index (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getFormulaDocs
Get a list of the functions available for use in a calculation- Returns:
- FormulaDocSummariesOutputV1
- Throws:
ApiException
- if fails to make API call
-
getFormulaDocsWithHttpInfo
public ApiClient.ApiResponse<FormulaDocSummariesOutputV1> getFormulaDocsWithHttpInfo() throws ApiExceptionGet a list of the functions available for use in a calculation- Throws:
ApiException
- if fails to make API call
-
getFormulaDocsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaDocSummariesOutputV1> getFormulaDocsWithHeadersAndHttpInfo(Map<String, String> customHeaders) throws ApiExceptionGet a list of the functions available for use in a calculation- Parameters:
customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getFormulaFunctions
public ItemPreviewListV1 getFormulaFunctions(String type, Integer offset, Integer limit) throws ApiException Get a collection of Formula Functions- Parameters:
type
- The type of Formula Functions that should be included. Valid options are FormulaFunction, AggregatingFormulaFunction, Chart, and UserDefinedFormulaFunction (optional, default to FormulaFunction)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- ItemPreviewListV1
- Throws:
ApiException
- if fails to make API call
-
getFormulaFunctionsWithHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getFormulaFunctionsWithHttpInfo(String type, Integer offset, Integer limit) throws ApiException Get a collection of Formula Functions- Parameters:
type
- The type of Formula Functions that should be included. Valid options are FormulaFunction, AggregatingFormulaFunction, Chart, and UserDefinedFormulaFunction (optional, default to FormulaFunction)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getFormulaFunctionsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getFormulaFunctionsWithHeadersAndHttpInfo(String type, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of Formula Functions- Parameters:
type
- The type of Formula Functions that should be included. Valid options are FormulaFunction, AggregatingFormulaFunction, Chart, and UserDefinedFormulaFunction (optional, default to FormulaFunction)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getFunction
Get a Formula Function- Parameters:
id
- ID of the function (required)- Returns:
- CalculatedItemOutputV1
- Throws:
ApiException
- if fails to make API call
-
getFunctionWithHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> getFunctionWithHttpInfo(String id) throws ApiException Get a Formula Function- Parameters:
id
- ID of the function (required)- Throws:
ApiException
- if fails to make API call
-
getFunctionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> getFunctionWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet a Formula Function- Parameters:
id
- ID of the function (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getItem
Get a Formula Item- Parameters:
id
- ID of the item (required)- Returns:
- FormulaItemOutputV1
- Throws:
ApiException
- if fails to make API call
-
getItemWithHttpInfo
public ApiClient.ApiResponse<FormulaItemOutputV1> getItemWithHttpInfo(String id) throws ApiException Get a Formula Item- Parameters:
id
- ID of the item (required)- Throws:
ApiException
- if fails to make API call
-
getItemWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaItemOutputV1> getItemWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet a Formula Item- Parameters:
id
- ID of the item (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getPackage
Get details of a specific package- Parameters:
packageName
- The name of the package (required)- Returns:
- FormulaPackageOutputV1
- Throws:
ApiException
- if fails to make API call
-
getPackageWithHttpInfo
public ApiClient.ApiResponse<FormulaPackageOutputV1> getPackageWithHttpInfo(String packageName) throws ApiException Get details of a specific package- Parameters:
packageName
- The name of the package (required)- Throws:
ApiException
- if fails to make API call
-
getPackageWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaPackageOutputV1> getPackageWithHeadersAndHttpInfo(String packageName, Map<String, String> customHeaders) throws ApiExceptionGet details of a specific package- Parameters:
packageName
- The name of the package (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getPackages
Get a collection of packages- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- ItemPreviewListV1
- Throws:
ApiException
- if fails to make API call
-
getPackagesWithHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getPackagesWithHttpInfo(Integer offset, Integer limit) throws ApiException Get a collection of packages- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getPackagesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getPackagesWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of packages- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
importPackage
public FormulaPackageImportOutputV1 importPackage(FormulaPackageImportInputV1 body) throws ApiException Create or update a package of UDFs with documentation.- Parameters:
body
- Complete package specifications to sync (required)- Returns:
- FormulaPackageImportOutputV1
- Throws:
ApiException
- if fails to make API call
-
importPackageWithHttpInfo
public ApiClient.ApiResponse<FormulaPackageImportOutputV1> importPackageWithHttpInfo(FormulaPackageImportInputV1 body) throws ApiException Create or update a package of UDFs with documentation.- Parameters:
body
- Complete package specifications to sync (required)- Throws:
ApiException
- if fails to make API call
-
importPackageWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaPackageImportOutputV1> importPackageWithHeadersAndHttpInfo(FormulaPackageImportInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update a package of UDFs with documentation.- Parameters:
body
- Complete package specifications to sync (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putFormulaDoc
public FormulaDocOutputV1 putFormulaDoc(String packageName, String docName, FormulaDocInputV1 body) throws ApiException Create or update the specified formula doc- Parameters:
packageName
- The name of the package (required)docName
- The name of the document for the desired function or index (required)body
- The details of the formula doc to create or update (required)- Returns:
- FormulaDocOutputV1
- Throws:
ApiException
- if fails to make API call
-
putFormulaDocWithHttpInfo
public ApiClient.ApiResponse<FormulaDocOutputV1> putFormulaDocWithHttpInfo(String packageName, String docName, FormulaDocInputV1 body) throws ApiException Create or update the specified formula doc- Parameters:
packageName
- The name of the package (required)docName
- The name of the document for the desired function or index (required)body
- The details of the formula doc to create or update (required)- Throws:
ApiException
- if fails to make API call
-
putFormulaDocWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaDocOutputV1> putFormulaDocWithHeadersAndHttpInfo(String packageName, String docName, FormulaDocInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update the specified formula doc- Parameters:
packageName
- The name of the package (required)docName
- The name of the document for the desired function or index (required)body
- The details of the formula doc to create or update (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putPackage
public FormulaPackageOutputV1 putPackage(String packageName, FormulaPackageInputV1 body) throws ApiException Create or update a package- Parameters:
packageName
- The name of the package (required)body
- (required)- Returns:
- FormulaPackageOutputV1
- Throws:
ApiException
- if fails to make API call
-
putPackageWithHttpInfo
public ApiClient.ApiResponse<FormulaPackageOutputV1> putPackageWithHttpInfo(String packageName, FormulaPackageInputV1 body) throws ApiException Create or update a package- Parameters:
packageName
- The name of the package (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
putPackageWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaPackageOutputV1> putPackageWithHeadersAndHttpInfo(String packageName, FormulaPackageInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update a package- Parameters:
packageName
- The name of the package (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
runFormula
public FormulaRunOutputV1 runFormula(String start, String end, String formula, String function, List<String> parameters, List<String> fragments, String root, String reduceFormula, Integer offset, Integer limit, String timeFormat) throws ApiException Run a Seeq Formula- Parameters:
start
- A string representing the starting index of the data to be returned. The contents and whether or not it is required depends on the result type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (optional)end
- A string representing the starting index of the data to be returned. The contents and whether or not it is required depends on the result type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (optional)formula
- The formula to be applied. This or function is required. (optional)function
- The ID of the function item to be computed. This or formula is required. (optional)parameters
- Parameters for the formula. Each parameter should have a format of 'name=value' where 'name' is the variable identifier, without the leading $ sign, and 'value' is the ID of an item or one of the following parameter expressions that can be used to access the properties of other items that are parameters: $signal.property('name') to access any property on an item, $signal.parentProperty('name') can be used if an item is in a tree to to access any property on the parent, and $signal.ancestors(', ') to return a list of all the ancestors, separated by the specified separator. In all of the above examples 'signal' would need to be another parameter that references an item using an ID. (optional)fragments
- Formula fragments for unbound inputs the function. Each parameter should have a format of 'name=formula' where 'name' is the variable identifier, without the leading $ sign, and 'formula' is a self-contained formula fragment (optional)root
- Used to run a formula across assets, this is the ID of the root asset whose immediate children will be iterated. The formula must produce a table. (optional)reduceFormula
- Used when running a formula across assets, this is a formula that can further reduce the results of each asset result. The variable $result must be used to reference the data. Example of sorting the aggregated results: $result.sort('temperature')' (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 1000)timeFormat
- (optional, default to Legacy)- Returns:
- FormulaRunOutputV1
- Throws:
ApiException
- if fails to make API call
-
runFormulaWithHttpInfo
public ApiClient.ApiResponse<FormulaRunOutputV1> runFormulaWithHttpInfo(String start, String end, String formula, String function, List<String> parameters, List<String> fragments, String root, String reduceFormula, Integer offset, Integer limit, String timeFormat) throws ApiException Run a Seeq Formula- Parameters:
start
- A string representing the starting index of the data to be returned. The contents and whether or not it is required depends on the result type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (optional)end
- A string representing the starting index of the data to be returned. The contents and whether or not it is required depends on the result type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (optional)formula
- The formula to be applied. This or function is required. (optional)function
- The ID of the function item to be computed. This or formula is required. (optional)parameters
- Parameters for the formula. Each parameter should have a format of 'name=value' where 'name' is the variable identifier, without the leading $ sign, and 'value' is the ID of an item or one of the following parameter expressions that can be used to access the properties of other items that are parameters: $signal.property('name') to access any property on an item, $signal.parentProperty('name') can be used if an item is in a tree to to access any property on the parent, and $signal.ancestors(', ') to return a list of all the ancestors, separated by the specified separator. In all of the above examples 'signal' would need to be another parameter that references an item using an ID. (optional)fragments
- Formula fragments for unbound inputs the function. Each parameter should have a format of 'name=formula' where 'name' is the variable identifier, without the leading $ sign, and 'formula' is a self-contained formula fragment (optional)root
- Used to run a formula across assets, this is the ID of the root asset whose immediate children will be iterated. The formula must produce a table. (optional)reduceFormula
- Used when running a formula across assets, this is a formula that can further reduce the results of each asset result. The variable $result must be used to reference the data. Example of sorting the aggregated results: $result.sort('temperature')' (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 1000)timeFormat
- (optional, default to Legacy)- Throws:
ApiException
- if fails to make API call
-
runFormulaWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaRunOutputV1> runFormulaWithHeadersAndHttpInfo(String start, String end, String formula, String function, List<String> parameters, List<String> fragments, String root, String reduceFormula, Integer offset, Integer limit, String timeFormat, Map<String, String> customHeaders) throws ApiExceptionRun a Seeq Formula- Parameters:
start
- A string representing the starting index of the data to be returned. The contents and whether or not it is required depends on the result type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (optional)end
- A string representing the starting index of the data to be returned. The contents and whether or not it is required depends on the result type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (optional)formula
- The formula to be applied. This or function is required. (optional)function
- The ID of the function item to be computed. This or formula is required. (optional)parameters
- Parameters for the formula. Each parameter should have a format of 'name=value' where 'name' is the variable identifier, without the leading $ sign, and 'value' is the ID of an item or one of the following parameter expressions that can be used to access the properties of other items that are parameters: $signal.property('name') to access any property on an item, $signal.parentProperty('name') can be used if an item is in a tree to to access any property on the parent, and $signal.ancestors(', ') to return a list of all the ancestors, separated by the specified separator. In all of the above examples 'signal' would need to be another parameter that references an item using an ID. (optional)fragments
- Formula fragments for unbound inputs the function. Each parameter should have a format of 'name=formula' where 'name' is the variable identifier, without the leading $ sign, and 'formula' is a self-contained formula fragment (optional)root
- Used to run a formula across assets, this is the ID of the root asset whose immediate children will be iterated. The formula must produce a table. (optional)reduceFormula
- Used when running a formula across assets, this is a formula that can further reduce the results of each asset result. The variable $result must be used to reference the data. Example of sorting the aggregated results: $result.sort('temperature')' (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 1000)timeFormat
- (optional, default to Legacy)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
runFormula_0
Run a Seeq Formula.- Parameters:
body
- Seeq Formula information (required)- Returns:
- FormulaRunOutputV1
- Throws:
ApiException
- if fails to make API call
-
runFormula_0WithHttpInfo
public ApiClient.ApiResponse<FormulaRunOutputV1> runFormula_0WithHttpInfo(FormulaRunInputV1 body) throws ApiException Run a Seeq Formula.- Parameters:
body
- Seeq Formula information (required)- Throws:
ApiException
- if fails to make API call
-
runFormula_0WithHeadersAndHttpInfo
public ApiClient.ApiResponse<FormulaRunOutputV1> runFormula_0WithHeadersAndHttpInfo(FormulaRunInputV1 body, Map<String, String> customHeaders) throws ApiExceptionRun a Seeq Formula.- Parameters:
body
- Seeq Formula information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
updateFunction
Update a function- Parameters:
id
- ID of the function to update (required)body
- Function information (required)- Returns:
- CalculatedItemOutputV1
- Throws:
ApiException
- if fails to make API call
-
updateFunctionWithHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> updateFunctionWithHttpInfo(String id, FunctionInputV1 body) throws ApiException Update a function- Parameters:
id
- ID of the function to update (required)body
- Function information (required)- Throws:
ApiException
- if fails to make API call
-
updateFunctionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> updateFunctionWithHeadersAndHttpInfo(String id, FunctionInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate a function- Parameters:
id
- ID of the function to update (required)body
- Function information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-