Interface IXperiflowTimeSeriesForecastingClient

Namespace: Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting

Assembly: Xperiflow.dll

Declaration

public interface IXperiflowTimeSeriesForecastingClient

Methods

GetAggregationTypeOptionsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

AggregationTypeOptionsResource

Declaration

Task<GetAggregationTypeOptionsResourceContext> GetAggregationTypeOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of acceptable options for the AggregationType_ enum located in the processing directory.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetAggregationTypeOptionsResourceContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFrequencyOverrideOptionsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

FrequencyOverridesOptionsResource

Declaration

Task<GetFrequencyOverrideOptionsResourceContext> GetFrequencyOverrideOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of acceptable options for the FrequencyOverrides_ enum located in the shared directory.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFrequencyOverrideOptionsResourceContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetMlTypeOptionsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

MLTypeOptionsResource

Declaration

Task<GetMlTypeOptionsResourceContext> GetMlTypeOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of acceptable options for the MLType_ enum located in the shared directory.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetMlTypeOptionsResourceContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetTuningStrategiesResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

TuningStrategiesResource

Declaration

Task<GetTuningStrategiesResourceResponseContext> GetTuningStrategiesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the available hyperparameter tuning strategies found in XperiFlow.

Possible status codes: 200, 500

Returns:

• query_status (Dict)

• If query was successful.

• strategies (List/[str/])

• A list of allowed hyperparameter tuning strategies

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetTuningStrategiesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetModelCollectionResourceAsync(XperiflowSessionInfo, string?, MemoizedCacheInfo?, CancellationToken)

ModelCollectionResource

Declaration

Task<GetModelCollectionResourceResponseContext> GetModelCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of all Xperiflow models

Query Parameters

• query (optional/[str/]): Pinq query filter expression * alias: str

• name of metric

• opttype: maximize, minimize

• the way this metric is optimized

• valuetype: percent, raw, log, squared, logsquared

• the type of value this metric represents

• aggregationtype: sum, mean, median

• how this metric is aggregated

• rangetype: upper_bounded, lower_bounded, unbounded, bounded

• the range this metric can take on

• bias: bool

• whether the metric is dealing with magnitude of error, or sums together positive and negative errors (is biased)

• common: bool

• is this a common well known metric

• goal: float

• the optimal value for this metric

• allowed_as_evaluation_metric: bool

• can this metric be used as the evaluation metric

Returns

• collection (List/[Dict/[str, Any/]/]): Each dictionary will be a model including the name, parent class, and all class attributes of the model.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetModelCollectionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	query	A pinq query string.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetMetricCollectionResourceAsync(XperiflowSessionInfo, string?, MemoizedCacheInfo?, CancellationToken)

MetricCollectionResource

Declaration

Task<GetMetricCollectionResourceResponseContext> GetMetricCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a collection of all metrics.

Query Parameters

• query (Optional/[str/]): Pinq query filter expression

Returns

• collection (List/[Dict/[str, Any/]/]): Each dictionary will be a metric including the name, parent class, and all class attributes of the metric.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetMetricCollectionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	query	A pinq query string.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetTransformerCollectionResourceAsync(XperiflowSessionInfo, int, string?, MemoizedCacheInfo?, CancellationToken)

TransformerCollectionResource

Declaration

Task<GetTransformerCollectionResourceResponseContext> GetTransformerCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string? query = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a collection of all transformers.

Query Parameters

• query (Optional/[str/]): Pinq query filter expression

Returns

• collection (List/[Dict/[str, Any/]/]): Each dictionary will be a transformer including the name, parent class, and all class attributes of the transformer.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetTransformerCollectionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	query	A pinq query string.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetSelectionAlgorithmCollectionResourceAsync(XperiflowSessionInfo, int, string?, MemoizedCacheInfo?, CancellationToken)

SelectionAlgorithmCollectionResource

Declaration

Task<GetSelectionAlgorithmCollectionResourceResponseContext> GetSelectionAlgorithmCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string? query = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of all selection algorithms

Query Parameters

• query (optional/[str/]): Pinq query filter expression

Returns

• collection (List/[Dict/[str, Any/]/]): Each dictionary will be an algorithm including the name, parent class, and all class attributes of the algorithm.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetSelectionAlgorithmCollectionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	query	A pinq query string.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostBuildInfoAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo, int, int, IntItemsIdentifierContext, MemoizedCacheInfo?, CancellationToken)

BuildInfoAssignmentsGeneratorsResource

Declaration

Task<NullDataXperiflowResponseContext> PostBuildInfoAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IntItemsIdentifierContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Set event and location IDs for a given top level xperimentbuild ID. This should be done at the target (not group) level.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.IntItemsIdentifierContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeletePipelineConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

PipelineConfigResource

Declaration

Task<NullDataXperiflowResponseContext> DeletePipelineConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Resets all PPO Configs under the provided BuildInfo unique identifier to use Auto Modeling.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostBuildInfoAssignmentsLocationsResourceAsync(XperiflowSessionInfo, int, int, IntItemsIdentifierContext, MemoizedCacheInfo?, CancellationToken)

BuildInfoAssignmentsLocationsResource

Declaration

Task<NullDataXperiflowResponseContext> PostBuildInfoAssignmentsLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IntItemsIdentifierContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Set location IDs for all target level xperimentbuilds for the given buildinfo.

Body Parameters: - location_ids: List[str] (guid)

• List of location IDs to assign to the xperimentbuild_id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.IntItemsIdentifierContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfoAssignmentsGeneratorsLocationsResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

BuildInfoAssignmentsGeneratorsLocationsResource

Declaration

Task<GetBuildInfoAssignmentsGeneratorsLocationsResourceResponseContext> GetBuildInfoAssignmentsGeneratorsLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve Number of Events and Locations assigned to target level xperimentbuild ids for a given buildinfo id.

Returns:

• filterable_data (paged DatatableContext): Count of Generators and Locations assigned to each target level xperimentbuild id.

  Columns are: XperimentBuildID, Name, Summation, GeneratorCount, LocationCount

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfoAssignmentsGeneratorsLocationsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

XperimentBuildAssignmentsGeneratorsResource

Declaration

Task<GetXperimentBuildAssignmentsGeneratorsResourceResponseContext> GetXperimentBuildAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve Generators and their assignment status for a given target level xperimentbuild ID.

Returns: - QueryPaginationDataTableResponseContext

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildAssignmentsGeneratorsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutXperimentBuildAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo, int, int, IntItemsIdentifierContext, MemoizedCacheInfo?, CancellationToken)

XperimentBuildAssignmentsGeneratorsResource

Declaration

Task<NullDataXperiflowResponseContext> PutXperimentBuildAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, IntItemsIdentifierContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Set generator config IDs for a given target level xperimentbuild ID. This should be done at the target (not group) level.

Body Parameters:

• xperimentbuild_id: int - The target level xperimentbuild ID to set generators for - item_ids: List[int] - List of event

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.IntItemsIdentifierContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutXperimentBuildsAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo, int, int, BodyXperimentBuildsAssignmentsGeneratorsDto, MemoizedCacheInfo?, CancellationToken)

XperimentBuildsAssignmentsGeneratorsResource

Declaration

Task<NullDataXperiflowResponseContext> PutXperimentBuildsAssignmentsGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyXperimentBuildsAssignmentsGeneratorsDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Applies multiple generators or events to multiple xperiment builds.

Body Params:

• project_id (str {guid}): The project unique identifier

• buildinfo_id (str {guid}): The build info unique identifier to commit the provided datasource to.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyXperimentBuildsAssignmentsGeneratorsDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildAssignmentsLocationsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildAssignmentsLocationsResource

Declaration

Task<GetXperimentBuildAssignmentsLocationsResourceResponseContext> GetXperimentBuildAssignmentsLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve Locations assigned to a given target level xperimentbuild ID.

Returns:

• locations_df (DatatableContext): Available locations to assign to the given target level xperimentbuild - locations_assigned_df (DatatableContext): Locations assigned to the given target level xperimentbuild

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildAssignmentsLocationsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostXperimentBuildAssignmentsLocationsResourceAsync(XperiflowSessionInfo, int, int, IntItemsIdentifierContext, MemoizedCacheInfo?, CancellationToken)

XperimentBuildAssignmentsLocationsResource

Declaration

Task<NullDataXperiflowResponseContext> PostXperimentBuildAssignmentsLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, IntItemsIdentifierContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Set location IDs for a given target level xperimentbuild ID.

Body Parameters: - xperimentbuild_id: int The target level xperimentbuild ID to set locations for - location_ids: List[int] List of location IDs to assign to the xperimentbuild_id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.IntItemsIdentifierContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutXperimentBuildsAssignmentsLocationsResourceAsync(XperiflowSessionInfo, int, int, BodyXperimentBuildsAssingmentsLocationsDto, MemoizedCacheInfo?, CancellationToken)

XperimentBuildsAssignmentsLocationsResource

Declaration

Task<NullDataXperiflowResponseContext> PutXperimentBuildsAssignmentsLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyXperimentBuildsAssingmentsLocationsDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Set location IDs for a given target level xperimentbuild ID.

Body Parameters: - xperimentbuild_id: int The target level xperimentbuild ID to set locations for - location_ids: List[str] (guid) List of location IDs to assign to the xperimentbuild_id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyXperimentBuildsAssingmentsLocationsDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostAttachDatabaseResourceAsync(XperiflowSessionInfo, BodyAttachDatabaseContext, MemoizedCacheInfo?, CancellationToken)

AttachDatabaseResource

Declaration

Task<NullableIntItemIdentifierXperiflowResponseContext> PostAttachDatabaseResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyAttachDatabaseContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Inserts a new project into the database

Body Params:

• name: optional/[str/]

• The project name

• description: optional/[str/]

• The project description

• application: optional/[str/]

• The project application name

• database_resource: optional/[str/]

• The project resource

• database_schema: optional/[str/]

• The database schema

• ptype: optional/[str/]

• The problem type

• ttype: optional/[str/]

• The time type

• vtype: optional/[str/]

• The vised type

Returns:

• AttachDataBaseResponse

• query_status: (querystatuscontext)

• message: (str)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullableIntItemIdentifierXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyAttachDatabaseContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetAutoConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

AutoConfigResource

Declaration

Task<GetAutoConfigResourceResponseContext> GetAutoConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves the auto ppo context for the provided buildinfo ID.

Returns:

• query_status (Dict)

• If query was successful.

• auto_ppo (Dict)

• lower_bound_train_duration_seconds (int)

  • The estimated least amount of time training can take.

• train_inflation_factor (int)

  • Factor to increase the lower estimated train time by

• allow_negative_targets (bool)

  • If target forecasts and inputs can be negative numbers.

• deploy_strategy (str)

  • "auto", "all", "best_three", or "best". Note "auto" will automatically determine the best option to use out of the other three options depending source data dataset properties (i.e number datapoints, number of targets, number of CPUs available etc.)

• clean_missing_method (str)

  • "zero" or "standard", whether to treat missing data as zeros or clean as we normally do

• evaluation_metric (str)

  • The evaluation metric to be used for all targets in the build

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetAutoConfigResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutAutoConfigResourceAsync(XperiflowSessionInfo, int, int, PutBodyAutoPpoContext, MemoizedCacheInfo?, CancellationToken)

AutoConfigResource

Declaration

Task<NullDataXperiflowResponseContext> PutAutoConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, PutBodyAutoPpoContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update the Auto PPO Configuration.

Body Parameters

/* train_inflation_factor: int

/* The amount to inflate the lower bound train time by. This inflation factor /* lower_bound_train_duration_seconds signifies how long the estimated run time will be for model training.

/* allow_negative_targets: bool

/* Whether or not to allow target values to be negative. All target historical values and prediction values that are less than zero will have their value clipped to be 0.

/* deploy_strategy: str

/* The deployment strategy to use when deploying the models into production (after training). Use "auto" if not sure. Auto will deploy a certain number of models per target dependent on a variety factors (i.e num datapoints per target, expected train time, etc)

/* clean_missing_method (str)

/* "zero" or "standard", whether to treat missing data as zeros or clean as we normally do

/* optimize_horizon(bool)

/* true or false, whether to optimize for the forecast range when training

/* evaluation_metric (str)

/* Must be a metric type such as "MeanAbsoluteError" or "MeanSquaredError". These metrics can be retrieved from the ModelingMetricsResource api.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PutBodyAutoPpoContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetAutoConfigSummaryResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

AutoConfigSummaryResource

Declaration

Task<GetAutoConfigSummaryResourceResponseContext> GetAutoConfigSummaryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

API to get the total number of targets using auto modelling vs manual.

returns

query_status: QueryStatusContext

number_auto: int

number_manual: int

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetAutoConfigSummaryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfoResourceAsync(XperiflowSessionInfo, int, int?, string?, MemoizedCacheInfo?, CancellationToken)

BuildInfoResource

Declaration

Task<GetBuildInfoResourceResponseContext> GetBuildInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int? buildinfo_id = null, string? by_latest_buildstate = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the attributes and properties related to a particular buildinfo. This is useful for getting the status of a certain buildinfo.

Query Parameter Info

The api allows you to pull buildinfo in 3 different ways

• Option 1: By BuildInfoID

• Provide project_id and buildinfo_id will return the buildinfo corresponding to the buildinfo_id

• Option 2: Provide only Project ID

• Providing only project_id will return the latest buildinfo (no matter its buildstate) - This is provided in the URL

• Option 3: By Latest Build State

• Provide project_id and by_latest_buildstate (train, deploy) will return the latest buildinfo that is in the buildstate provided.

Returns:

• query_status (Dict)

• If query was successful.

• buildinfo_id (str {guid})

• The buildinfo ID. This will be the same as what was queried with.

• mlclass_type (str)

• The machine learning class type that is associated with this particular buildinfo.

• start_time (str {dt.datetime})

• The time at which the buildinfo was created. This is synonymous with the beginning of a model build process.

• end_time (str {dt.datetime})

• The time at which the buildinfo completed its modelbuild process. This will be set to "1900-01-01T00:00:00" in the event that the

buildinfo has completed its training state. * build_type (str)

• Options for months to retrieve in consumption

• build_state (str)

• Options for hours to retrieve in consumption

• mutable (bool)

• Whether or not the associated buildinfo objects are still able to be altered.

• is_online (bool)

• Whether or not the buildinfo is currently online. An offline buildinfo would mean that its models are no longer active and have

been archived in favor of newer, rebuilt models. * buildinfo_output (Optional/[BuildInfoOutputContext/])

• Various key value pairs related to the buildinfo. This will be None if this API is retrieved prior to the DataConfig job.

• buildfill (Optional/[BuildFillOutputContext/])

• Various key value paris related to the buildfill/rebuild information of this buildinfo. This will be None if the API is retrieve

prior to the DataConfig job.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfoResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Nullable<System.Int32>	buildinfo_id	the unique identifier associated with the buildinfo.
System.String	by_latest_buildstate	The latest build state to retrieve by
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutBuildInfoArchiveResourceAsync(XperiflowSessionInfo, int, int, BodyBuildInfoArchiveContext, MemoizedCacheInfo?, CancellationToken)

BuildInfoArchiveResource

Declaration

Task<NullableIntItemIdentifierXperiflowResponseContext> PutBuildInfoArchiveResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyBuildInfoArchiveContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Convert a buildinfo (and corresponding xperimentbuilds) to offline status. Optionally create a new buildinfo with same buildfill (auto/manual and full/partial) as buildinfo that was archived. This api should only be run after a successful dataload for a project

Scenarios where request will be deemed unsuccessful:

• Buildinfo is already offline

• Buildinfo currently has an attached buidinfo state object that is not in a "finished" state (completed, syserror, syscanceled, etc.)

• Buildinfo does not exist

• BuildInfo is in a deployed state

• Buildinfo does not have a statecollection object called "dataload"

• Buildinfo "dataload" statecollection object is not completed

Body Parameters:

• restart (bool):

• If a new buildinfo should be created and returned. This should be set to true in the event of a "restart" as opposed to a "delete"

Returns:

• modified (bool)

• If buildinfo was successfully modified

• msg (str)

• Return message

• buildinfo_id (Optional/[str {guid}/]):

• Will be the guid of the new buildinfo if restart is set to true and request is successful. Otherwise, will be null

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullableIntItemIdentifierXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyBuildInfoArchiveContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfoAuditResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

BuildInfoAuditResource

Declaration

Task<GetBuildInfoAuditResourceResponseContext> GetBuildInfoAuditResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves a JSON DataTable of Deployed BuildInfo related information. Each record in this JSON DataTable corresponds to a Deployed BuildInfo.

Note: The "GroupingInfo" field is a JSON field within the JSON DataTable.

Returns:

• Query status (querystatus)

• buildinfo_history (datatable)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfoAuditResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfoBacktestResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

BuildInfoBacktestResource

Declaration

Task<GetBuildInfoBacktestResourceResponseContext> GetBuildInfoBacktestResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves High level statistics from the pipeline run, win margins, and vm statistics

Returns:

• query_status (Dict)

• If query was successful.

• model_deployed_df(DataTableContext)

• The name of deployed models and the count deployed

• pipeline_stats_df(DatatableContext)

• Two column dataframe with the name of a statistics and the value

• win_margin_df (DataTableContext):

• DataFrame that contains the win margin of each target for their best model against their best baseline for every metric and the

corresponding portion of the dataset that these metrics were computed on. * vms_cpu (DataTableContext):

• Contains the average cpu utilization of all servers agaisnt time for the pipeline job.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfoBacktestResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfoConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

BuildInfoConfigResource

Declaration

Task<GetBuildInfoConfigResourceResponseContext> GetBuildInfoConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

This will update the Output Context for a Buildinfo.

Input:

run_feature_generation: Optional[bool]

run_feature_transformation: Optional[bool]

run_feature_selection: Optional[bool]

allow_grouping: Optional[bool]

feature_generation_threshold: Optional[int]

feature_transformation_threshold: Optional[int]

feature_selection_threshold: Optional[int]

grouping_threshold: Optional[int]

Returns:

buildinfo_id: int

modified: bool

message: str

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfoConfigResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutBuildInfoConfigResourceAsync(XperiflowSessionInfo, int, int, BodyBuildinfoConfigContext, MemoizedCacheInfo?, CancellationToken)

BuildInfoConfigResource

Declaration

Task<NullDataXperiflowResponseContext> PutBuildInfoConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyBuildinfoConfigContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

This will update the Output Context for a Buildinfo.

Input:

run_feature_generation: Optional[bool]

run_feature_transformation: Optional[bool]

run_feature_selection: Optional[bool]

allow_grouping: Optional[bool]

feature_generation_threshold: Optional[int]

feature_transformation_threshold: Optional[int]

feature_selection_threshold: Optional[int]

grouping_threshold: Optional[int]

Returns:

buildinfo_id: int

modified: bool

message: str

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyBuildinfoConfigContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteBuildInfoConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

BuildInfoConfigResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteBuildInfoConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

This will reset the Output Context for a Buildinfo.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetModelThresholdsConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

ModelThresholdsConfigResource

Declaration

Task<GetModelThresholdsConfigResourceResponseContext> GetModelThresholdsConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the model thresholds.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetModelThresholdsConfigResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutModelThresholdsConfigResourceAsync(XperiflowSessionInfo, int, int, BodyModelThresholdsContext, MemoizedCacheInfo?, CancellationToken)

ModelThresholdsConfigResource

Declaration

Task<NullDataXperiflowResponseContext> PutModelThresholdsConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyModelThresholdsContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update the model thresholds.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyModelThresholdsContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteModelThresholdsConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

ModelThresholdsConfigResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteModelThresholdsConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

This will reset the model thresholds.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetHierarchyConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

HierarchyConfigResource

Declaration

Task<GetHierarchyConfigResourceResponseContext> GetHierarchyConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the Hierarchical Config

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetHierarchyConfigResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostHierarchyConfigResourceAsync(XperiflowSessionInfo, int, int, BodyHierarchyConfigContext, MemoizedCacheInfo?, CancellationToken)

HierarchyConfigResource

Declaration

Task<NullDataXperiflowResponseContext> PostHierarchyConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyHierarchyConfigContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update the Hierarchical Config

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyHierarchyConfigContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteHierarchyConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

HierarchyConfigResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteHierarchyConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Deletes the Hierarchical Config

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfosResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, bool?, MemoizedCacheInfo?, CancellationToken)

BuildInfosResource

Declaration

Task<GetBuildInfosResourceResponseContext> GetBuildInfosResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, bool? include_offline = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve a datatable of buildinfo information with each row corresponding to a different buildinfo. Columns include ID, StarTime, EndTime, BuildType, BuildState, NumTargets, NumSingleTargets, NumGroups.

Query parameter is available to determine if offline buildinfos should be included in the table.

Returns:

• query_status (Dict)

• buildinfo_data(DataTableContext)

  • Datatable containing buildinfos' information

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfosResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
System.Nullable<System.Boolean>	include_offline	If to include offline buildinfos in the results.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfoStateResourceAsync(XperiflowSessionInfo, int, string?, string?, int?, MemoizedCacheInfo?, CancellationToken)

BuildInfoStateResource

Declaration

Task<GetBuildInfoStateResourceResponseContext> GetBuildInfoStateResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string? by_latest_buildstate = null, string? buildinfo_state = null, int? buildinfo_id = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the buildinfo state and related status variables that are tied to a particular buildinfo. This is useful for defining different page restrictions and getting how far through the pipeline a particular buildinfo is.

Definitions

It's important to call out the distinction between BuildInfo State and BuildState given that they are so close in name.

/* BuildInfo State: The distinct states that occur within a buildinfo

/* Build State: The current form of the BuildInfo object. This will either be "train" or "deploy".

Available BuildInfo States:

/* DataConfigOrchestrator

/* FeatureDataSourceValidationCommit

/* DataLoadOrchestrator

/* PipelineOrchestrator

/* FeaturePipelineOrchestrator

/* ModelingPipelineOrchestrator

/* DeployOrchestrator

/* ModelRebuildOrchestrator

Query Parameter Info

The api allows you to pull buildinfo state in 3 different ways (similar accessors to BuildInfo API). The optional buildinfo state string will look for that buildinfo state if provided, otherwise it will look for the latest buildinfo state based on starttime.

/* Option 1: By BuildInfoID + BuildInfoState

/* Provide project_id and buildinfo_id will search for the buildinfo states corresponding to the buildinfo_id

/* Option 2: Provide only Project ID + BuildInfoState

/* Providing only project_id will will search for the buildinfo states associated with the latest buildinfo (no matter its buildstate)

/* Option 3: By Latest Build State + BuildInfoState

/* Provide project_id and by_latest_buildstate (train, deploy) will search for the buildinfo states the latest buildinfo that is in

the buildstate provided.

Returns:

/* query_status (Dict)

/* If query was successful.

/* buildinfo_id (str {guid})

/* The buildinfo ID. This will be the same as what was queried with.

/* is_complete (bool)

/* Whether or not the "buildinfo_state" was found and was completed.

/* is_found (bool)

/* Whether or not the provided "buildinfo_state" was found with the associated "buildinfo_id".

/* activity_status (Optional/[str/])

/* The activity status of the "buildinfo_state" that was provided as the query parameter. This will be None if the "buildinfo_state"

was not found. /* state_name (Optional/[str/])

/* The "buildinfo_state" that was provided as the query parameter (just resurfacing in the the response). This will be None if the

"buildinfo_state" was not found /* state_type (Optional/[str/])

/* The underlying object that defines the state. Will either be "job" or "task". This will be None if the "is_found" is False.

/* state_id: (Optional/[str {Guid}/]):

/* The underlying object ID that defines the state. This will either be a JobID or TaskID corresponding to the "state_type". This

will be None if the "is_found" is False.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfoStateResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	by_latest_buildstate	The latest build state to retrieve by
System.String	buildinfo_state	The current buildinfo state to check for if it's complete. If none, then gets the latest
System.Nullable<System.Int32>	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildSummaryResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

BuildSummaryResource

Declaration

Task<GetBuildSummaryResourceResponseContext> GetBuildSummaryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

This returns the total number of targets (target level) and number of target groups (top level)

Returns:

• query_status (Dict)

• targets (int)

• Number of total targets for the given buildinfo_id

• single_targets (int)

• Number of single targets for the given buildinfo_id

• groups(int)

• Number of groups for the given buildinfo_id

• groups_and_single_targets (int)

• Number of groups and single level targets for given buildinfo_id (essentially the sum of 'single_targets' and 'groups')

• total_models_trained (Optional/[int/])

• The total number of models trained for given buildinfo_id

• total_modeliterations (Optional/[int/])

• The total hyperparameter tuning iterations for given buildinfo_id

• total_featuresgenerated (Optional/[int/])

• The total features generated for given buildinfo_id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildSummaryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetCrossValidationSplitsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

CrossValidationSplitsResource

Declaration

Task<GetCrossValidationSplitsResourceResponseContext> GetCrossValidationSplitsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get api for retrieving cross validation split blobs for a given project_id and buildinfo_id.

• query_status (Dict)

• If query was successful.

• cv_strategy_type (str)

• The name of the crossvalidation strategy type

• splits List(str)

• A list of cross validation split blobs for the given project_id and buildinfo_id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetCrossValidationSplitsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetConsumptionGroupResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

ConsumptionGroupResource

Declaration

Task<GetConsumptionGroupResourceResponseContext> GetConsumptionGroupResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int consumption_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves the Consumption group asked for by the id in the url

Returns:

• query_status (Dict)

• If query was successful.

• consumption (ConsumptionContext):

• Defines the consumption group and the options chosen.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetConsumptionGroupResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	consumption_id	the unique identifier associated with the consumption group.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutConsumptionGroupResourceAsync(XperiflowSessionInfo, int, BodyConsumptionContext, int, MemoizedCacheInfo?, CancellationToken)

ConsumptionGroupResource

Declaration

Task<NullDataXperiflowResponseContext> PutConsumptionGroupResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, BodyConsumptionContext body, int consumption_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

ConsumptionGroupResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyConsumptionContext	body
System.Int32	consumption_id	the unique identifier associated with the consumption group.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteConsumptionGroupResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

ConsumptionGroupResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteConsumptionGroupResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int consumption_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Deletes a consumption context in database by id.

Body Parameters:

• project_id (str {guid}):

• The name of the location. Cannot match another location already inserted.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	consumption_id	the unique identifier associated with the consumption group.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetConsumptionGroupsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

ConsumptionGroupsResource

Declaration

Task<GetConsumptionGroupsResourceResponseContext> GetConsumptionGroupsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

ConsumptionGroupsResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetConsumptionGroupsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostConsumptionGroupsResourceAsync(XperiflowSessionInfo, int, BodyConsumptionPbmInputsDto, MemoizedCacheInfo?, CancellationToken)

ConsumptionGroupsResource

Declaration

Task<PostConsumptionGroupsResourceResponseContext> PostConsumptionGroupsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, BodyConsumptionPbmInputsDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Inserts a consumption group into the database.

Body Parameters:

• project_id (str {int}):

• The name of the location. Cannot match another location already inserted.

• consumption (ConsumptionContext):

• The consumption context defining the group. Ex :

"consumption":
  {
  "group_name": "group1",
  "group_type": "time",
  "output_table_name": "modelforecast",
  "creation_time": "2021-09-17 07:42:27.8276660",
  "attributes_context": {
      "start_time": null,
      "end_time": null,
      "extraction_type": "batch",
      "models_to_return": "all"
  },
  "uid": "{`{consumption_id}`}"
  }

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostConsumptionGroupsResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyConsumptionPbmInputsDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostConsumptionPBMResourceAsync(XperiflowSessionInfo, int, BodyConsumptionPbmDto, MemoizedCacheInfo?, CancellationToken)

ConsumptionPBMResource

Declaration

Task<NullableIntItemIdentifierXperiflowResponseContext> PostConsumptionPBMResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, BodyConsumptionPbmDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Create a new consumption workflow

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullableIntItemIdentifierXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyConsumptionPbmDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataExplorationResourceAsync(XperiflowSessionInfo, int, int, bool, string?, MemoizedCacheInfo?, CancellationToken)

DataExplorationResource

Declaration

Task<GetDataExplorationResourceResponseContext> GetDataExplorationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, bool columndata_only, string? column_name = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns the Explore stats for source dataset

Returns:

• frequency (str):

• The frequency of the dataset. One of (

• columndata_dataset (DataFrame):

• The Json DataTable holding the columndata information.

• timeseries_dataset (DataFrame):

• The Json DataTable holding the time series data.

Note: The columndata_dataset "Name" column will match the values in the timeseries_dataset "Intersection" column.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataExplorationResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Boolean	columndata_only
System.String	column_name
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataExplorationOptionsResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, string?, IEnumerable<string>?, MemoizedCacheInfo?, CancellationToken)

DataExplorationOptionsResource

Declaration

Task<GetDataExplorationOptionsResourceResponseContext> GetDataExplorationOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, string? filter_series = null, IEnumerable<string>? filter_mltypes = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns the Explore options for the source dataset. Designed to be used in conjunction with the DataExplorationResource.

Returns:

• query_status (Dict)

  • Contains key: "status" If the query succeeded or not

• filterable_data(DataFrame):

  • The Json DataTable holding the columndata information (Name, ShortName, Summation).

• query_manager_column_info (List/[ColumnInfoContext/]):

  • List of info for each column, if it can be filtered/ordered by/etc.

• total_pages (int):

  • The total pages for all records

• total_records (int):

  • The total records across all pages

• records_per_page (int):

  • The number of records per page

• page (int):

  • The page number of the query

• order_bys (dict):

  • Any order bys used in the query and how they were used (ASC/DESC)

• filterable_series (List/[str/]):

  • List of series that can be filtered by

• filter_series (Optional/[str/]):

  • The series used to filter in the query

• filterable_mltypes (List/[str/]):

  • List of mltypes that can be filtered by

• filter_mltypes (Optional/[str/]):

  • The mltype used to filter on

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataExplorationOptionsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
System.String	filter_series
System.Collections.Generic.IEnumerable<System.String>	filter_mltypes
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetBuildInfoAssignmentsSummaryResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

BuildInfoAssignmentsSummaryResource

Declaration

Task<GetBuildInfoAssignmentsSummaryResourceResponseContext> GetBuildInfoAssignmentsSummaryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

This returns location and generator assignment statistics for the specific buildinfo id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetBuildInfoAssignmentsSummaryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostGeneratorPackagesApplyResourceAsync(XperiflowSessionInfo, int, int, GeneratorPackagesApplyBodyContext, MemoizedCacheInfo?, CancellationToken)

GeneratorPackagesApplyResource

Declaration

Task<NullDataXperiflowResponseContext> PostGeneratorPackagesApplyResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, GeneratorPackagesApplyBodyContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

GeneratorPackagesApplyResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GeneratorPackagesApplyBodyContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFeatureEffectsResourceAsync(XperiflowSessionInfo, int, IEnumerable<int>?, IEnumerable<int>?, string?, bool?, bool?, int?, MemoizedCacheInfo?, CancellationToken)

FeatureEffectsResource

Declaration

Task<GetFeatureEffectsResourceResponseContext> GetFeatureEffectsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<int>? xperimentkernel_ids = null, IEnumerable<int>? xperimentbuild_ids = null, string? model_pinq = null, bool? all_deployed = null, bool? include_failed_models = null, int? num_models = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get api for retrieving feature effect statistics for a given xperimentkernel. If the xperimentkernel relates to a baseline model, the query status will be false because feature effect statistics should not exist. Xperimentkernels relating to non-baseline models should have a successful query.

• query_status (QueryStatusContext)

• If query was successful.

• statistics (DataTableContext) - Contains the feature effect statistics data

• FeatureName

• FeatureValue

• PredictionAvgValue

• TargetAvgValue

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFeatureEffectsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.Int32>	xperimentkernel_ids	List of xperimentkernel ids to get metrics for
System.Collections.Generic.IEnumerable<System.Int32>	xperimentbuild_ids	List of xperimentbuild ids to get metrics for.
System.String	model_pinq	Optional[str]: A pinq query to get specific models for
System.Nullable<System.Boolean>	all_deployed	If only deployed models should be shown
System.Nullable<System.Boolean>	include_failed_models	If failed models should be shown
System.Nullable<System.Int32>	num_models	Number of models
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFeaturesGeneratedResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

FeaturesGeneratedResource

Declaration

Task<GetFeaturesGeneratedResourceResponseContext> GetFeaturesGeneratedResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve a table containing all of the generated features for a given project.

Returns:

• query_status (Dict)

  • If query was successful.

• generated_features (DataTableContext):

  • Table containing each generated feature in the project as a row

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFeaturesGeneratedResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFeaturesGeneratedDatatypesResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

FeaturesGeneratedDatatypesResource

Declaration

Task<GetFeaturesGeneratedDatatypesResourceResponseContext> GetFeaturesGeneratedDatatypesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get feature summary statistic by buildinfo id which contains in the features_summary_df two columns, one with the datatype name "dtype" and one with the number of columndatum of that datatype "dtype_count" given the buildinfo.

• query_status (Dict) - If query was successful. - features_summary_df (DatatableContext) - Each row is a datatype with count

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFeaturesGeneratedDatatypesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFeatureImpactResourceAsync(XperiflowSessionInfo, int, IEnumerable<int>?, IEnumerable<int>?, string?, bool?, bool?, int?, MemoizedCacheInfo?, CancellationToken)

FeatureImpactResource

Declaration

Task<GetFeatureImpactResourceResponseContext> GetFeatureImpactResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<int>? xperimentkernel_ids = null, IEnumerable<int>? xperimentbuild_ids = null, string? model_pinq = null, bool? all_deployed = null, bool? include_failed_models = null, int? num_models = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get api for retrieving feature Impact statistics for a list of xperimentkernel_ids. Can be either a list of a single str kernel_id or a list of multiple.

• query_status (QueryStatusContext)

• If query was successful.

• statistics (DataTableContext) - Contains the feature Impact statistics data

• FeatureName

• FeatureImpact

• XperimentKernelID

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFeatureImpactResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.Int32>	xperimentkernel_ids	List of xperimentkernel ids to get metrics for
System.Collections.Generic.IEnumerable<System.Int32>	xperimentbuild_ids	List of xperimentbuild ids to get metrics for.
System.String	model_pinq	Optional[str]: A pinq query to get specific models for
System.Nullable<System.Boolean>	all_deployed	If only deployed models should be shown
System.Nullable<System.Boolean>	include_failed_models	If failed models should be shown
System.Nullable<System.Int32>	num_models	Number of models
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFeatureTransformersDistributionResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

FeatureTransformersDistributionResource

Declaration

Task<GetFeatureTransformersDistributionResourceResponseContext> GetFeatureTransformersDistributionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get feature summary statistic by buildinfo id which is contained in the features_summary_df two columns, one with the transformer name "Transformer" and one with the number of columndatum of that used that transformer "transformer_count" given the buildinfo.

• query_status (Dict)

• If query was successful.

• features_summary_df (DatatableContext)

• Each row is a transformer with count

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFeatureTransformersDistributionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFeaturesSummaryResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

FeaturesSummaryResource

Declaration

Task<GetFeaturesSummaryResourceResponseContext> GetFeaturesSummaryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get feature summary statistic by buildinfo id which contains the latest of the following information in the features_summary_df

"total_unique_generated_features"

"total_unique_selected_features"

"max_feature_selection_rounds"

"feature_transformation_rounds"

"feature_engineering_duration"

• query_status (Dict) - If query was successful. - features_summary_df (DatatableContext) - One row with all the statistics above

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFeaturesSummaryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGlobalFeatureGeneralizationResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

GlobalFeatureGeneralizationResource

Declaration

Task<GetGlobalFeatureGeneralizationResourceResponseContext> GetGlobalFeatureGeneralizationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the global feature generalization statistic datatable by buildinfo id.

• query_status (Dict)

  • If query was successful.

• features_summary_df (DatatableContext)

  • Each row is a feature with its with count

  • Columns:

    • feature_name: The feature name

    • short_name: Feature short name

    • dtype: The dtype of the feature

    • total: The total number of targets that this feature was eligible to be used with

    • utilized: The total number of targets that this feature was found useful for

    • utilization_percentage: The percentage of eligible targets that this feature was useful for.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetGlobalFeatureGeneralizationResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetForecastResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

ForecastResource

Declaration

Task<GetForecastResourceResponseContext> GetForecastResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the forecast for the given project ID included in URL.

Returns:

• "range_step": (int)

• "collection_lag_step": (int)

• query status

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetForecastResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutForecastResourceAsync(XperiflowSessionInfo, int, int, ForecastConfigCollectionContext, MemoizedCacheInfo?, CancellationToken)

ForecastResource

Declaration

Task<NullDataXperiflowResponseContext> PutForecastResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, ForecastConfigCollectionContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Set the forecast for the given project_id.

Body Parameters:

• range_step: int

• How far forward to forecast from this given moment in time (number of datapoints)

• collection_lag_step: int

• The far backward in turns row steps the data source lags behind this given moment in time.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.ForecastConfigCollectionContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetForecastOptionsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

ForecastOptionsResource

Declaration

Task<GetForecastOptionsResourceResponseContext> GetForecastOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the forecast options for the given project ID.

Returns:

• query_status (Dict):

• Contains key "status". If query succeeded.

• steps(DataFrame):

• The dataframe with steps options.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetForecastOptionsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetForecastInfoResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

ForecastInfoResource

Declaration

Task<GetForecastInfoResourceResponseContext> GetForecastInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the forecast info for the given project ID.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetForecastInfoResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGroupingResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

GroupingResource

Declaration

Task<GetGroupingResourceResponseContext> GetGroupingResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets Data for presentation on the Data Profile page of the Sensible ML application. In particular, this data retrieve the target distribution data in increments of 1 percentiles.

Returns:

• query_status (Dict)

• Contains status whether the query succeeded or not.

• buildinfo_id (str {guid})

• The buildinfo unique identifier.

• grouping (GroupingContext):

• The grouping methodology to use when grouping targets together.

Additional Notes on GroupingContext:

The grouping context is a dictionary that contains the following keys: * "option" (str): The option to use for grouping. The option can be one of the following:

• "significance"

• "cluster"

• "none"

• "80-20"

• "auto"

• "cluster"

• "dimensions"

• "uniform"

• "data" (dict): additional data that is required for the specific option. The data is different for each option. * "enable_grouping_across_hierarchies" (Optional[bool]): If true, then the grouping will be applied across all hierarchies. If false, then the grouping will be applied within each hierarchy.

The grouping context supports the following options:

• By Target Significance:

• Description: Group targets based on their respective significance. Significance is determined by summing all values for each respective

target and dividing by the total overall sum of targets to get a "significance percentage" per target.

• option: "significance"

• data: VolumeData

  • "start" (int/[0 - 100/]): The starting percentage to group

  • "end" (int/[{start} - 100/]): The ending percent to group

  • "detail" (Optional/[int/]):

    • None means no algorithmic clustering to cluster the significance range further

    • /-1 will auto cluster the significance range further and will automatically choose the best cluster for you.

    • greater than 1 will set the specific number of clusters for algorithmic clustering the significance range.)

• By Clustering

• Option: "cluster"

• data: TargetGrouperByClusterContext

  • num_clusters (int): If -1 then auto clustering, otherwise must be > 0 and the number will be the number of clusters.

• No Grouping:

• Description: No grouping will be applied an all targets will remain as single targets.

• option: "None" Note that this is the string "None" not None as in no value.

• data: None

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetGroupingResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostGroupingResourceAsync(XperiflowSessionInfo, int, int, GroupingContext, MemoizedCacheInfo?, CancellationToken)

GroupingResource

Declaration

Task<NullDataXperiflowResponseContext> PostGroupingResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, GroupingContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Inserts or updates the Grouping Definition for a particular project and buildinfo.

Body_Parameters:

• project_id (str {guid}): - The name of the location. Cannot match another location already inserted. - buildinfo_id (str {guid}): - The description of the location - grouping (GroupingContext): - See examples of "grouping" found in the (GET) Grouping API examples.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GroupingContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGroupingOptionsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

GroupingOptionsResource

Declaration

Task<GetGroupingOptionsResourceResponseContext> GetGroupingOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get available grouping options by project id

/* query_status (Dict)

/* If query was successful.

/* options (DatatableContext)

/* Each row is key value pair for grouping options

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetGroupingOptionsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGeneratorCompatibilityResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

GeneratorCompatibilityResource

Declaration

Task<GetGeneratorCompatibilityResourceResponseContext> GetGeneratorCompatibilityResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get generators and their compatibility/in use by buildinfo id and project id

• query_status (Dict)

  • If the query was successful.

• compatibility_datatable (DatatableContext)

  • Each row is a given generator and if it is compatible with the build

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetGeneratorCompatibilityResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGeneratorConfigurationsResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

GeneratorConfigurationsResource

Declaration

Task<GetGeneratorConfigurationsResourceResponseContext> GetGeneratorConfigurationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get information regarding currently configured generators for a given buildinfo id

• query_status (Dict)

  • If query was successful.

• configurations_datatable (DatatableContext)

  • Each row is a given configuration

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetGeneratorConfigurationsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostGeneratorConfigurationsResourceAsync(XperiflowSessionInfo, int, int, BodyGeneratorConfigurationsContext, MemoizedCacheInfo?, CancellationToken)

GeneratorConfigurationsResource

Declaration

Task<PostGeneratorConfigurationsResourceResponseContext> PostGeneratorConfigurationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyGeneratorConfigurationsContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Insert a generator config for a given buildinfo id. The init kwargs will be validated upon post to verify they are correct, but the correct init kwargs can be seen from the GeneratorCollectionResource's init_kwargs. Exactly one of init_kwargs being set or use_generate_init_kwargs being true should be provided.

Body params:

• generator (str): The generator to use

• init_params_json (dict): The init params to use with the generator

• fit_params_json (dict): The fit params to use with the generator

• bypass_feature_selection (bool): If generated features should bypass feature selection. This defaults to False and should be used sparingly

• scenario_features (bool): Whether the specified generator should be used as a scenario feature or not. This defaults to False

• description (str, Optional): An optional description of the generator

Returns:

• generator_config_id (int): The created id.

• modified (bool): If query was successful.

• message (str): Any necessary message.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostGeneratorConfigurationsResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyGeneratorConfigurationsContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteGeneratorConfigurationsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

GeneratorConfigurationsResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteGeneratorConfigurationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete all generator configs for a given buildinfo id. This will set back to pipeline default generator configs.

Query Params:

None

Returns:

• generator_config_id (guid): The created id.

• modified (bool): If query was successful.

• message (str): Any necessary message.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostGeneratorConfigurationsBulkDeleteResourceAsync(XperiflowSessionInfo, int, int, IntItemsIdentifierContext, MemoizedCacheInfo?, CancellationToken)

GeneratorConfigurationsBulkDeleteResource

Declaration

Task<NullDataXperiflowResponseContext> PostGeneratorConfigurationsBulkDeleteResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IntItemsIdentifierContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a list of generator config ids for a given buildinfo id.

Body params:

• item_ids (List[Guid]): The generators to delete

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.IntItemsIdentifierContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutGeneratorConfigurationResourceAsync(XperiflowSessionInfo, int, int, int, BodyGeneratorConfigurationContext, MemoizedCacheInfo?, CancellationToken)

GeneratorConfigurationResource

Declaration

Task<NullDataXperiflowResponseContext> PutGeneratorConfigurationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int generator_config_id, BodyGeneratorConfigurationContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update a given generator config id. The init kwargs will be validated upon post to verify they are correct, but the correct init kwargs can be seen from the GeneratorCollectionResource's init_kwargs. Exactly one of init_kwargs being set or use_generate_init_kwargs being true should be provided.

Body params:

• init_kwargs (dict, optional): The init kwargs to use with the generator

• use_generate_init_kwargs (bool, optional): If initkwargs should be generated. This defaults to False

• bypass_feature_selection (bool, optional): If generated features should bypass feature selection. This defaults to False and should be used sparingly

Returns:

• generator_config_id (guid): The updated id.

• modified (bool): If query was successful.

• message (str): Any necessary message.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Int32	generator_config_id	the unique identifier associated with the generator config.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyGeneratorConfigurationContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteGeneratorConfigurationResourceAsync(XperiflowSessionInfo, int, int, int, MemoizedCacheInfo?, CancellationToken)

GeneratorConfigurationResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteGeneratorConfigurationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int generator_config_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a given generator config.

Query Params:

None

Returns:

• generator_config_id (guid): The deleted id.

• modified (bool): If query was successful.

• message (str): Any necessary message.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Int32	generator_config_id	the unique identifier associated with the generator config.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGroupingTargetDistributionResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

GroupingTargetDistributionResource

Declaration

Task<GetGroupingTargetDistributionResourceResponseContext> GetGroupingTargetDistributionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets Data for presentation on the Data Profile page of the Sensible ML application. In particular, this data retrieve the target distribution data in increments of 1 percentiles.

Returns:

• grouping_distribution (DataTableContext) - The grouping distribution where each group broken down by significance and total number of targets. Note that all single series are treated as a group for comparison purposes. - total_targets (int) - The total number of targets present in this buildinfo.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetGroupingTargetDistributionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetScenariosResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

ScenariosResource

Declaration

Task<GetScenariosResourceResponseContext> GetScenariosResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets Scenarios that have been created for a given buildinfo id. This is a paged api and it is likely it will be filtered on forecast start date column

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetScenariosResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostScenariosResourceAsync(XperiflowSessionInfo, int, int, BodyScenariosContext, MemoizedCacheInfo?, CancellationToken)

ScenariosResource

Declaration

Task<PostScenariosResourceResponseContext> PostScenariosResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyScenariosContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Create a scenario with a given name, description, and forecast start date.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostScenariosResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyScenariosContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetScenarioResourceAsync(XperiflowSessionInfo, int, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

ScenarioResource

Declaration

Task<GetScenarioResourceResponseContext> GetScenarioResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int scenario_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets Features that are part of a scenario. This is a paged api.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetScenarioResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Int32	scenario_id	the unique identifier associated with the scenario.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutScenarioResourceAsync(XperiflowSessionInfo, int, int, int, BodyScenarioContext, MemoizedCacheInfo?, CancellationToken)

ScenarioResource

Declaration

Task<NullDataXperiflowResponseContext> PutScenarioResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int scenario_id, BodyScenarioContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update an existing scenario's name and description

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Int32	scenario_id	the unique identifier associated with the scenario.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyScenarioContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteScenarioResourceAsync(XperiflowSessionInfo, int, int, int, MemoizedCacheInfo?, CancellationToken)

ScenarioResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteScenarioResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int scenario_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a scenario and associated scenario features.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Int32	scenario_id	the unique identifier associated with the scenario.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetScenarioFeatureDataResourceAsync(XperiflowSessionInfo, int, int, int, int, string?, MemoizedCacheInfo?, CancellationToken)

ScenarioFeatureDataResource

Declaration

Task<GetScenarioFeatureDataResourceResponseContext> GetScenarioFeatureDataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int scenario_id, int datatable_id, string? hashkey = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets a given feature's data for a given scenario.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetScenarioFeatureDataResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Int32	scenario_id	the unique identifier associated with the scenario.
System.Int32	datatable_id
System.String	hashkey
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutScenarioFeatureDataResourceAsync(XperiflowSessionInfo, int, int, int, ScenarioFeatureDataBodyContext, MemoizedCacheInfo?, CancellationToken)

ScenarioFeatureDataResource

Declaration

Task<NullDataXperiflowResponseContext> PutScenarioFeatureDataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int scenario_id, ScenarioFeatureDataBodyContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Updates the data for a given Scenario Feature. Data is currently just a dictionary with format {"data": bytes}.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Int32	scenario_id	the unique identifier associated with the scenario.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.ScenarioFeatureDataBodyContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetFeatureValuesResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>, IEnumerable<string>, string?, string?, MemoizedCacheInfo?, CancellationToken)

FeatureValuesResource

Declaration

Task<GetFeatureValuesDataResourceResponseContext> GetFeatureValuesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string> predictioncall_ids, IEnumerable<string> xperimentbuild_ids, string? start_date = null, string? end_date = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get api for retrieving feature values from a prediction call ID and a xperiment build ID using a start date, end date for filtration. * query_status (QueryStatusContext)

• If query was successful.

• feature values (DataTableContext) - Contains the feature values data

• FeatureNames

• FeatureValues

• FeatureDates

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetFeatureValuesDataResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	predictioncall_ids	the list of prediction call ids
System.Collections.Generic.IEnumerable<System.String>	xperimentbuild_ids	the start date where you want to filter your prediction from
System.String	start_date	the start date of when you want to filter your prediction from
System.String	end_date	the end date of when you want to filter your prediction from
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentKernelResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentKernelResource

Declaration

Task<GetXperimentKernelResourceResponseContext> GetXperimentKernelResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentkernel_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns information about the XperimentKernel requested.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentKernelResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentkernel_id	the unique identifier associated with the xperimentkernel.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetModelMetadataResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, int?, int?, string?, bool?, bool?, MemoizedCacheInfo?, CancellationToken)

ModelMetadataResource

Declaration

Task<GetModelMetadataResourceResponseContext> GetModelMetadataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, int? xperimentbuild_id = null, int? xperimentkernel_id = null, string? modelstage = null, bool? onlydistinct = null, bool? deployed = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get api for retrieving metadata for a given xperimentbuild and/or xperimentkernel. The modelstage query parameter can be used to filter the data prior to retrieval. Must provide atleast 1 of xperimentbuild_id or xperimentkernel_id. ModelStage parameter is completely optional.

• query_status (Dict)

• If query was successful.

• model_metadata (DatatableContext) - Contains data related to the modelmetadata.

• ModelName

• ModelStage

• IsBaseline

• EvaluationMetricType

• IsBacktest

• EvaluatorDatasetType

• PipelineRank

• XperimentKernelID

• XperimentBuildID

• ModelMetaData

• ModelType

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetModelMetadataResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
System.Nullable<System.Int32>	xperimentbuild_id	Xperimentbuild unique identifier'
System.Nullable<System.Int32>	xperimentkernel_id	Xperimentkernel unique identifier'
System.String	modelstage	Modelstage to get metadata for. Optional'
System.Nullable<System.Boolean>	onlydistinct	Whether to give back results only for the unique combinations of XperimentKernelID and ModelStage
System.Nullable<System.Boolean>	deployed
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPipelineMetricResultResourceAsync(XperiflowSessionInfo, int, string, IEnumerable<int>?, IEnumerable<int>?, string?, bool?, bool?, int?, IEnumerable<int>?, bool?, string?, string?, MemoizedCacheInfo?, CancellationToken)

PipelineMetricResultResource

Declaration

Task<GetPipelineMetricResultResourceResponseContext> GetPipelineMetricResultResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string model_stage, IEnumerable<int>? xperimentkernel_ids = null, IEnumerable<int>? xperimentbuild_ids = null, string? model_pinq = null, bool? all_deployed = null, bool? include_failed_models = null, int? num_models = null, IEnumerable<int>? split_ids = null, bool? representative_only = null, string? dataset_type = null, string? metrics_pinq_query = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve metrics for a pipeline model stage.

Body Params:

• project_id: Guid

  • The guid to associate with project

• name: optional/[str/]

  • The project name

• description: optional/[str/]

  • The project description

• application: optional/[str/]

  • The project application name

• database_resource: optional/[str/]

  • The project resource

• database_schema: optional/[str/]

  • The database schema

• ptype: optional/[str/]

  • The problem type

• ttype: optional/[str/]

  • The time type

• vtype: optional/[str/]

  • The vised type

Returns:

• AttachDataBaseResponse

  • query_status: (querystatuscontext)

  • message: (str)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPipelineMetricResultResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	model_stage
System.Collections.Generic.IEnumerable<System.Int32>	xperimentkernel_ids	List of xperimentkernel ids to get metrics for
System.Collections.Generic.IEnumerable<System.Int32>	xperimentbuild_ids	List of xperimentbuild ids to get metrics for.
System.String	model_pinq	Optional[str]: A pinq query to get specific models for
System.Nullable<System.Boolean>	all_deployed	If only deployed models should be shown
System.Nullable<System.Boolean>	include_failed_models	If failed models should be shown
System.Nullable<System.Int32>	num_models	Number of models
System.Collections.Generic.IEnumerable<System.Int32>	split_ids
System.Nullable<System.Boolean>	representative_only
System.String	dataset_type
System.String	metrics_pinq_query
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPipelineTimeseriesDataResourceAsync(XperiflowSessionInfo, int, string, IEnumerable<int>?, IEnumerable<int>?, string?, bool?, bool?, int?, IEnumerable<int>?, bool?, string?, string?, string?, MemoizedCacheInfo?, CancellationToken)

PipelineTimeseriesDataResource

Declaration

Task<GetPipelineTimeseriesDataResourceResponseContext> GetPipelineTimeseriesDataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string model_stage, IEnumerable<int>? xperimentkernel_ids = null, IEnumerable<int>? xperimentbuild_ids = null, string? model_pinq = null, bool? all_deployed = null, bool? include_failed_models = null, int? num_models = null, IEnumerable<int>? split_ids = null, bool? representative_only = null, string? dataset_type = null, string? metrics_pinq_query = null, string? merge_method = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve metrics for a pipeline model stage.

Body Params:

• project_id: Guid

  • The guid to associate with project

• name: optional/[str/]

  • The project name

• description: optional/[str/]

  • The project description

• application: optional/[str/]

  • The project application name

• database_resource: optional/[str/]

  • The project resource

• database_schema: optional/[str/]

  • The database schema

• ptype: optional/[str/]

  • The problem type

• ttype: optional/[str/]

  • The time type

• vtype: optional/[str/]

  • The vised type

Returns:

• AttachDataBaseResponse

  • query_status: (querystatuscontext)

  • message: (str)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPipelineTimeseriesDataResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	model_stage
System.Collections.Generic.IEnumerable<System.Int32>	xperimentkernel_ids	List of xperimentkernel ids to get metrics for
System.Collections.Generic.IEnumerable<System.Int32>	xperimentbuild_ids	List of xperimentbuild ids to get metrics for.
System.String	model_pinq	Optional[str]: A pinq query to get specific models for
System.Nullable<System.Boolean>	all_deployed	If only deployed models should be shown
System.Nullable<System.Boolean>	include_failed_models	If failed models should be shown
System.Nullable<System.Int32>	num_models	Number of models
System.Collections.Generic.IEnumerable<System.Int32>	split_ids
System.Nullable<System.Boolean>	representative_only
System.String	dataset_type
System.String	metrics_pinq_query
System.String	merge_method	str: The method to merge overlapping predictions
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPredictionMetricResultResourceAsync(XperiflowSessionInfo, int, bool, IEnumerable<int>?, IEnumerable<int>?, string?, bool?, bool?, int?, string?, DateTime?, int?, IEnumerable<int>?, MemoizedCacheInfo?, CancellationToken)

PredictionMetricResultResource

Declaration

Task<GetPredictionMetricResultResourceResponseContext> GetPredictionMetricResultResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, bool aggregated_metrics, IEnumerable<int>? xperimentkernel_ids = null, IEnumerable<int>? xperimentbuild_ids = null, string? model_pinq = null, bool? all_deployed = null, bool? include_failed_models = null, int? num_models = null, string? metrics_pinq_query = null, DateTime? forecast_date = null, int? forecast_num = null, IEnumerable<int>? prediction_call_ids = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve metrics for a pipeline model stage.

Body Params:

• project_id: Guid

  • The guid to associate with project

• name: optional/[str/]

  • The project name

• description: optional/[str/]

  • The project description

• application: optional/[str/]

  • The project application name

• database_resource: optional/[str/]

  • The project resource

• database_schema: optional/[str/]

  • The database schema

• ptype: optional/[str/]

  • The problem type

• ttype: optional/[str/]

  • The time type

• vtype: optional/[str/]

  • The vised type

Returns:

• AttachDataBaseResponse

  • query_status: (querystatuscontext)

  • message: (str)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPredictionMetricResultResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Boolean	aggregated_metrics	If to retrieve the metrics aggregated across predictions
System.Collections.Generic.IEnumerable<System.Int32>	xperimentkernel_ids	List of xperimentkernel ids to get metrics for
System.Collections.Generic.IEnumerable<System.Int32>	xperimentbuild_ids	List of xperimentbuild ids to get metrics for.
System.String	model_pinq	Optional[str]: A pinq query to get specific models for
System.Nullable<System.Boolean>	all_deployed	If only deployed models should be shown
System.Nullable<System.Boolean>	include_failed_models	If failed models should be shown
System.Nullable<System.Int32>	num_models	Number of models
System.String	metrics_pinq_query	A pinq query to get specific metric types
System.Nullable<System.DateTime>	forecast_date	List of split ids to gather metrics for.
System.Nullable<System.Int32>	forecast_num	The portion of the split to gather metrics for.
System.Collections.Generic.IEnumerable<System.Int32>	prediction_call_ids
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPredictionTimeseriesDataResourceAsync(XperiflowSessionInfo, int, bool, string, bool, IEnumerable<int>?, IEnumerable<int>?, string?, bool?, bool?, int?, bool?, IEnumerable<int>?, MemoizedCacheInfo?, CancellationToken)

PredictionTimeseriesDataResource

Declaration

Task<GetPredictionTimeseriesDataResourceResponseContext> GetPredictionTimeseriesDataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, bool include_offline, string merge_method, bool include_prior_data, IEnumerable<int>? xperimentkernel_ids = null, IEnumerable<int>? xperimentbuild_ids = null, string? model_pinq = null, bool? all_deployed = null, bool? include_failed_models = null, int? num_models = null, bool? merge_on_forecast_name = null, IEnumerable<int>? prediction_call_ids = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

NOTE: Only get best model if not querying using model_pinq nor xperimentkernel_ids

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPredictionTimeseriesDataResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Boolean	include_offline	If to retrieve predictions for offline models
System.String	merge_method	The method to merge overlapping predictions
System.Boolean	include_prior_data	If prior actuals data should be included in resulting df
System.Collections.Generic.IEnumerable<System.Int32>	xperimentkernel_ids	List of xperimentkernel ids to get metrics for
System.Collections.Generic.IEnumerable<System.Int32>	xperimentbuild_ids	List of xperimentbuild ids to get metrics for.
System.String	model_pinq	Optional[str]: A pinq query to get specific models for
System.Nullable<System.Boolean>	all_deployed	If only deployed models should be shown
System.Nullable<System.Boolean>	include_failed_models	If failed models should be shown
System.Nullable<System.Int32>	num_models	Number of models
System.Nullable<System.Boolean>	merge_on_forecast_name	If to perform the merge_method on forecast name column
System.Collections.Generic.IEnumerable<System.Int32>	prediction_call_ids
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPredictionExplanationsResourceAsync(XperiflowSessionInfo, int, string, IEnumerable<int>?, IEnumerable<int>?, string?, bool?, bool?, int?, bool?, bool?, IEnumerable<int>?, string?, MemoizedCacheInfo?, CancellationToken)

PredictionExplanationsResource

Declaration

Task<GetPredictionExplanationsResourceResponseContext> GetPredictionExplanationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string model_stage, IEnumerable<int>? xperimentkernel_ids = null, IEnumerable<int>? xperimentbuild_ids = null, string? model_pinq = null, bool? all_deployed = null, bool? include_failed_models = null, int? num_models = null, bool? latest_only = null, bool? representative_only = null, IEnumerable<int>? split_ids = null, string? dataset_type = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get api for retrieving prediction explanation statistics for a given xperimentkernel. If the xperimentkernel relates to a baseline model, the query status will be false because prediction explanation statistics should not exist. Xperimentkernels relating to non-baseline models should have a successful query as long as their prediction explanation did not fail.

• query_status (Dict)

  • If query was successful.

• prediction_explanation_name (str)

  • The name of the prediction explanation

• implementation_type (str)

  • Either internal or external implementation

• prediction_explanation_type (str)

  • The type of the prediction explanation

• explanation_data (DataTableContext)

  • The datatable containing the prediction explanations. Columns include: "Index", "Target", and one additional column for each feature

• model_name (str)

  • Name of the model that the prediction explanation is for.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPredictionExplanationsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	model_stage	str: The modelstage of prediction explanations to retrieve. One of (hyperparametertuning, model_selection, hyperparameter_backtest_holdout, softtrain, prediction)
System.Collections.Generic.IEnumerable<System.Int32>	xperimentkernel_ids	List of xperimentkernel ids to get metrics for
System.Collections.Generic.IEnumerable<System.Int32>	xperimentbuild_ids	List of xperimentbuild ids to get metrics for.
System.String	model_pinq	Optional[str]: A pinq query to get specific models for
System.Nullable<System.Boolean>	all_deployed	If only deployed models should be shown
System.Nullable<System.Boolean>	include_failed_models	If failed models should be shown
System.Nullable<System.Int32>	num_models	Number of models
System.Nullable<System.Boolean>	latest_only	(Optional[bool]): If only the most recent prediction explanations are desired. Defaults to False
System.Nullable<System.Boolean>	representative_only	Whether only want representative split or not
System.Collections.Generic.IEnumerable<System.Int32>	split_ids	Optional[List[Guid]]: List of splits want the prediction explanations for
System.String	dataset_type	The datasettyoe to get prediction explanations for
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetProjectResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

ProjectResource

Declaration

Task<GetProjectResourceResponseContext> GetProjectResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve information related to a Project Definition.

Returns:

• query_status (Dict)

• If query was successful.

• project_id (int)

• The project ID retrieved

• name (str)

• The name of the project

• description (str)

• The description of the project

• application (str)

• The name of the application the project corresponds to

• database_resource (str)

• The database resource

• database_schema (str)

• The database schema

• ptype (str)

• ttype(str)

• vtype(str)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetProjectResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutProjectResourceAsync(XperiflowSessionInfo, int, PutBodyProjectContext, MemoizedCacheInfo?, CancellationToken)

ProjectResource

Declaration

Task<NullDataXperiflowResponseContext> PutProjectResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, PutBodyProjectContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update a project.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PutBodyProjectContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteProjectResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

ProjectResource

Declaration

Task<DeleteProjectResourceResponseContext> DeleteProjectResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete the project and create a job to delete the database associated with the project.

Body Parameters:

• None

Returns:

• project/_id (str{guid})

• The project ID retrieved

• job/id (str{guid})

• The ID of the job that is posted for deleting the project database

• modified (bool)

• If the project can be deleted

• message (str)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.DeleteProjectResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetProjectsResourceAsync(XperiflowSessionInfo, string?, string?, string?, string?, string?, MemoizedCacheInfo?, CancellationToken)

ProjectsResource

Declaration

Task<GetProjectsResourceResponseContext> GetProjectsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? ptype = null, string? ttype = null, string? vtype = null, string? app_name = null, string? x_OS_Username = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves the list of XperiFlow projects. Can either filter by MLCLASSPK, or app_name.

Returns:

• query_status (Dict)

• If query was successful.

• projects (DatatableContext)

• Each row is a project

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetProjectsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	ptype	The problem type to filter the projects by.
System.String	ttype	The time type to filter the projects by.
System.String	vtype	The vised type to filter the projects by.
System.String	app_name	The name of application to filter by.
System.String	x_OS_Username
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetRebuildOptionsTypeResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

RebuildOptionsTypeResource

Declaration

Task<GetRebuildOptionsTypeResourceResponseContext> GetRebuildOptionsTypeResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Provides the possible build types (auto or manual) in a key_value df datatable context

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetRebuildOptionsTypeResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetProjectDatabaseQueryResourceAsync(XperiflowSessionInfo, int, string, string, MemoizedCacheInfo?, CancellationToken)

ProjectDatabaseQueryResource

Declaration

Task<GetProjectDatabaseQueryResourceResponseContext> GetProjectDatabaseQueryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string authentication_key, string sql_query, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Perform a select query against a project database. Extra care needs to be taken when using this api because it can get a project into a bad state. The project for which this query is to be performed against is provided as a url parameter.

NOTE: This api must be provided an authentication_key in the query parameters. See Luke Heberling for the authentication key. Example authentication keys are incorrect.

Query Parameters:

• authentication_key: str

• Authentication key to be allowed to hit this api

• sql_query: str

• The sql query to perform against the given project database.

Returns:

• query_status (Dict)

• If query was successful.

• datatable (DatatableContext)

• Datatable containing any data retrieved from the sql query.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetProjectDatabaseQueryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	authentication_key
System.String	sql_query
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostProjectDatabaseQueryResourceAsync(XperiflowSessionInfo, int, ProjectDatabaseQueryContext, MemoizedCacheInfo?, CancellationToken)

ProjectDatabaseQueryResource

Declaration

Task<NullDataXperiflowResponseContext> PostProjectDatabaseQueryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, ProjectDatabaseQueryContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Perform a insert/update/delete query against a project database. Extra care needs to be taken when using this api because it can get a project into a bad state. The project for which this query is to be performed against is provided as a url parameter.

NOTE: This api must be provided an authentication_key in the query parameters. See Luke Heberling for the authentication key. Example authentication keys are incorrect.

Body Parameters:

• authentication_key: str

• Authentication key to be allowed to hit this api

• sql_query: str

• The sql query to perform against the given project database.

Returns:

• modified: (bool): whether the query was executed successfully

• message (str): Will tell you if the query was successful, or will include error if unsuccessful.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.ProjectDatabaseQueryContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetHierarchySourceDataMetricsResourceAsync(XperiflowSessionInfo, int, int, string, MemoizedCacheInfo?, CancellationToken)

HierarchySourceDataMetricsResource

Declaration

Task<GetHierarchySourceDatMetricsResponseContext> GetHierarchySourceDataMetricsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, string hierarchy_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the artifacts of a hierarchy in a project.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetHierarchySourceDatMetricsResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.String	hierarchy_name	the unique name of a hierarchy associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetRebuildOptionsFillResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

RebuildOptionsFillResource

Declaration

Task<GetRebuildOptionsFillResourceResponseContext> GetRebuildOptionsFillResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Provides the possible fill types (full or partial) in a key_value df datatable context

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetRebuildOptionsFillResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetRebuildOptionsFillPartialResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

RebuildOptionsFillPartialResource

Declaration

Task<GetRebuildOptionsFillPartialResourceResponseContext> GetRebuildOptionsFillPartialResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Provides the possible methods to do a partial rebuild in a key_value df datatable context.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetRebuildOptionsFillPartialResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetRebuildOptionsFillPartialNumbersResourceAsync(XperiflowSessionInfo, int, string, MemoizedCacheInfo?, CancellationToken)

RebuildOptionsFillPartialNumbersResource

Declaration

Task<GetRebuildOptionsFillPartialNumbersResourceResponseContext> GetRebuildOptionsFillPartialNumbersResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string partial_option, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Provides the possible numbers to be used in conjunction with a given partial rebuild option. The 2 types of partial rebuild options are currently: "Less Than X Health" and "X % Bottom Performers". The response is sent back in a key_value_df as a datatable context with the keys and values being numerical options.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetRebuildOptionsFillPartialNumbersResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	partial_option	The type of rebuild option chosen
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetTargetSummaryResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

TargetSummaryResource

Declaration

Task<GetTargetSummaryResourceResponseContext> GetTargetSummaryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get overview statistics of your targets given buildinfo id and project id.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetTargetSummaryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetTargetSignificanceResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

TargetSignificanceResource

Declaration

Task<GetTargetSignificanceResourceResponseContext> GetTargetSignificanceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets Data for presentation on the Data Profile page of the Sensible ML application. In particular, this data retrieve the target distribution data in increments of 1 percentiles.

Returns:

• target_distribution (DataTableContext) - The target distribution data ranging from 1 - 100 percentiles. - total_targets (int) - The total number of targets present in this buildinfo.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetTargetSignificanceResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceAttributesResourceAsync(XperiflowSessionInfo, int, string, int, string, MemoizedCacheInfo?, CancellationToken)

DataSourceAttributesResource

Declaration

Task<GetDataSourceAttributesResourceResponseContext> GetDataSourceAttributesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, int datasource_level_id, string attributes_context_type, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns Datasource attributes definition.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceAttributesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
System.Int32	datasource_level_id
System.String	attributes_context_type
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutDataSourceAttributesResourceAsync(XperiflowSessionInfo, int, string, BodyDataSourceAttributesContext, MemoizedCacheInfo?, CancellationToken)

DataSourceAttributesResource

Declaration

Task<NullDataXperiflowResponseContext> PutDataSourceAttributesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, BodyDataSourceAttributesContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Updates Datasource attributes definition.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyDataSourceAttributesContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceConnectionResourceAsync(XperiflowSessionInfo, int, string, MemoizedCacheInfo?, CancellationToken)

DataSourceConnectionResource

Declaration

Task<GetDataSourceConnectionResourceResponseContext> GetDataSourceConnectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the DataSource Connection information for a given datasource name.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceConnectionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceDataFormResourceAsync(XperiflowSessionInfo, int, string, MemoizedCacheInfo?, CancellationToken)

DataSourceDataFormResource

Declaration

Task<GetDataSourceDataFormResourceResponseContext> GetDataSourceDataFormResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

DataSourceDataFormResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceDataFormResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceDataFormSummaryResourceAsync(XperiflowSessionInfo, int, string, MemoizedCacheInfo?, CancellationToken)

DataSourceDataFormSummaryResource

Declaration

Task<GetDataSourceDataFormSummaryResourceResponseContext> GetDataSourceDataFormSummaryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve various statistics related the datasource name that was provided. The frequency statistic is a dictionary with the key as the frequency type and the value as the number of intersections with that frequency.

Frequency Options with Recommended Mapping:

/* H -> Hourly

/* D -> Daily

/* W -> Weekly

/* MS -> Monthly

/* QS -> Quarterly

/* YS -> Yearly

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceDataFormSummaryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostDataSourceFeatureCommitPBMResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

DataSourceFeatureCommitPBMResource

Declaration

Task<PostDataSourceFeatureCommitPbmResourceResponseContext> PostDataSourceFeatureCommitPBMResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Entrypoint for component workflow, the output to be passed into the FeatureDataValidation job.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostDataSourceFeatureCommitPbmResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostDataSourceCommitResourceAsync(XperiflowSessionInfo, int, int, string, MemoizedCacheInfo?, CancellationToken)

DataSourceCommitResource

Declaration

Task<NullDataXperiflowResponseContext> PostDataSourceCommitResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Commits a Feature DataSource to the BuildInfo. Note that there are only certain states of the Build that this is an allowed action.

Body Params:

• project_id (str {guid}): The project unique identifier

• buildinfo_id (str {guid}): The build info unique identifier to commit the provided datasource to.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteDataSourceCommitResourceAsync(XperiflowSessionInfo, int, int, string, MemoizedCacheInfo?, CancellationToken)

DataSourceCommitResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteDataSourceCommitResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Commits a Feature DataSource to the BuildInfo. Note that there are only certain states of the Build that this is an allowed action.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostDataSourcesCommitResourceAsync(XperiflowSessionInfo, int, int, BodyDataSourcesCommitDto, MemoizedCacheInfo?, CancellationToken)

DataSourcesCommitResource

Declaration

Task<NullDataXperiflowResponseContext> PostDataSourcesCommitResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyDataSourcesCommitDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Commits multiple Feature DataSources to the BuildInfo. Note that there are only certain states of the Build that this is an allowed action.

Body Params:

• project_id (str {guid}): The project unique identifier

• buildinfo_id (str {guid}): The build info unique identifier to commit the provided datasource to.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyDataSourcesCommitDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteDataSourcesCommitResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, MemoizedCacheInfo?, CancellationToken)

DataSourcesCommitResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteDataSourcesCommitResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? data_source_names = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Deletes datasource corresponding to a given buildinfo_id.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	data_source_names	A list of strings containing data source names
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourcesDataFormsResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, string?, MemoizedCacheInfo?, CancellationToken)

DataSourcesDataFormsResource

Declaration

Task<GetDataSourcesDataFormsResourceResponseContext> GetDataSourcesDataFormsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, string? dataform_type = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

DataSourcesDataFormsResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourcesDataFormsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
System.String	dataform_type
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourcesAttributesResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

DataSourcesAttributesResource

Declaration

Task<GetDataSourcesAttributesResourceResponseContext> GetDataSourcesAttributesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Given the project ID and the buildinfo ID, get the following info for each feature table with the given buildinfo id:

{
  "DataSourceLevelID": "00000000-0000-0000-0000-000000000000",

  "DataSourceName": "MyDatasource2",

  "KnownInAdvance": 17,

  "BypassFeatureSelection": 0,

  "AllowFeatureEngineering": 35,

  "Committed": false
}

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourcesAttributesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceResourceAsync(XperiflowSessionInfo, int, string, int?, string?, MemoizedCacheInfo?, CancellationToken)

DataSourceResource

Declaration

Task<GetDataSourceResourceResponseContext> GetDataSourceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, int? row_count = null, string? source_name = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a datasource with the given datasource name. This will be unsuccessful if the datasource name doesn't exist, corresponds to a target datasource, and can filter by number of rows.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
System.Nullable<System.Int32>	row_count	The number of rows to return in the request.
System.String	source_name	The name of the source to pull data from. This might be a file name or database table name.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteDataSourceResourceAsync(XperiflowSessionInfo, int, string, MemoizedCacheInfo?, CancellationToken)

DataSourceResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteDataSourceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a feature datasource with the given datasource name. This will be unsuccessful if the datasource name doesn't exist, corresponds to a target datasource, or is committed to an online buildinfo.

Body Params:

• None

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceSnapshotCollectionLagsResourceAsync(XperiflowSessionInfo, int, bool, int, MemoizedCacheInfo?, CancellationToken)

DataSourceSnapshotCollectionLagsResource

Declaration

Task<GetDataSourceSnapshotCollectionLagsResourceResponseContext> GetDataSourceSnapshotCollectionLagsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, bool online, int snapshot_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get collection lags of data source snapshot by snapshot id, project id, and boolean of whether lag should be online (from current time) or offline (from latest time in source data). This returns three columns, the bin name, the distribution vector and the cumulative vector (see example for reference)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceSnapshotCollectionLagsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Boolean	online
System.Int32	snapshot_id	the unique identifier associated with a snapshot.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceSnapshotMessagesResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

DataSourceSnapshotMessagesResource

Declaration

Task<GetDataSourceSnapshotMessagesResourceResponseContext> GetDataSourceSnapshotMessagesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int snapshot_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the health messages for a snapshot given a project id and snapshot id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceSnapshotMessagesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	snapshot_id	the unique identifier associated with a snapshot.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourcesSnapshotsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

DataSourcesSnapshotsResource

Declaration

Task<GetDataSourcesSnapshotsResourceResponseContext> GetDataSourcesSnapshotsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get data source snapshot statistics by project id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourcesSnapshotsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourcesSnapshotsExecutionTimesResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

DataSourcesSnapshotsExecutionTimesResource

Declaration

Task<GetDataSourcesSnapshotsExecutionTimesResourceResponseContext> GetDataSourcesSnapshotsExecutionTimesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the datasource snapshot table by project id

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourcesSnapshotsExecutionTimesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceTargetResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

DataSourceTargetResource

Declaration

Task<GetDataSourceTargetResourceResponseContext> GetDataSourceTargetResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves Connection Context and DataForm Context information for the Target DataSource of the project.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceTargetResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostDataSourcesTargetCommitPBMResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

DataSourceTargetCommitPBMResource

Declaration

Task<PostDataSourceTargetCommitPbmResourceResponseContext> PostDataSourcesTargetCommitPBMResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Entrypoint for component workflow, the output to be passed into the TargetDataValidation job.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostDataSourceTargetCommitPbmResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostDataSourceUpdatePBMResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

DataSourceUpdatePBMResource

Declaration

Task<PostDataSourceUpdatePbmResourceResponseContext> PostDataSourceUpdatePBMResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Entrypoint for component workflow, the output to be passed into the DataSourceUpdate job.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostDataSourceUpdatePbmResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetHierarchyTargetStatResourceAsync(XperiflowSessionInfo, int, string, MemoizedCacheInfo?, CancellationToken)

HierarchyTargetStatResource

Declaration

Task<GetDatasourceTargetStatResponseContext> GetHierarchyTargetStatResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets the number of targets per hierarchy combination for a target dataset

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDatasourceTargetStatResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.String	datasource_name	Name of the datasource.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDeploymentSummaryResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

DeploymentSummaryResource

Declaration

Task<GetDeploymentSummaryResourceResponseContext> GetDeploymentSummaryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Given a particular project ID this returns the total number of targets, single_targets, groups, groups_and_single_targets in a utilization setting as well as the time the most recent prediction was started.

See: BuildStatistics

Query Parameter Info

/-Provide project_id will return the target size information corresponding to the utilizationof the project

Returns:

• query_status (Dict)

• targets (int)

• Number of total targets in utilization for the given project_id

• single_targets (int)

• Number of single targets in utilization for the given project_id

• groups(int)

• Number of groups in utilization for the given project_id

• groups_and_single_targets (int)

• Number of groups and single level targets in utilization for given project_id (essentially the sum of 'single_targets' and 'groups')

• last_prediction (datetime)

• The starttime of the most recent prediction for the given project_id. Will be null if no predictions have been run yet.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDeploymentSummaryResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetHealthResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

HealthResource

Declaration

Task<GetHealthResourceResponseContext> GetHealthResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve 2 datatablecontexts for the given project id. These datatables will be useful for making rebuild decisions.

Returns:

• query_status (Dict) - If query was successful. - healthscore_bin_data (DatatableContext) - Datatable containing data for binning targets into healthscore distribution graph. Includes bin importance column - statistics_data (DatatableContext) - Datatable containing various statistics for project performance

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetHealthResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetHealthSummaryStatisticsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

HealthSummaryStatisticsResource

Declaration

Task<GetHealthSummaryStatisticsResourceResponseContext> GetHealthSummaryStatisticsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve different overviews of model performance.

Returns:

• query_status (Dict)

• If query was successful.

• avg_model_metrics (DatatableContext)

• Metrics (includes train time) for different models averaged across all targets that had the same backtest dataset type. Additionally averages across dataset type of prediction.

• model_names_count_metrics (DatatableContext)

• The number of targets and number of groups using each type of model

• metric_names_count_target (DatatableContext)

• The number of targets and number of groups using each type of evaluation metric

• dataset_types_count_target (DatatableContext)

• The number of targets that have the given dataset type as the latest part of their model build split

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetHealthSummaryStatisticsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetHealthBaselineWinMarginResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

HealthBaselineWinMarginResource

Declaration

Task<GetHealthBaselineWinMarginResourceResponseContext> GetHealthBaselineWinMarginResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves High level statistics from the pipeline run, win margins, and vm statistics

Returns:

• query_status (Dict)

• If query was successful.

• avg_win_margin(DataTableContext):

• DataFrame that contains the win margin of (max 10) sets of targets for their best model against their best baseline for every prediction

metric. There will be sets of targets for prediction dataset type and any other dataset types for pipeline. The pipeline dataset type will be the latest part of the split that was available during that build for the target. Will also contain a column of the average target size in the set of targets

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetHealthBaselineWinMarginResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetLocationsResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

LocationsResource

Declaration

Task<GetLocationsResourceResponseContext> GetLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns the list of locations for a project

Returns:

• query_status (Dict):

• Contains key: "status" If the query has succeeded

• location_dt_json (DataFrame):

• The dataframe of locations returned

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetLocationsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostLocationsResourceAsync(XperiflowSessionInfo, int, BodyLocationContext, MemoizedCacheInfo?, CancellationToken)

LocationsResource

Declaration

Task<PostLocationsResourceResponseContext> PostLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, BodyLocationContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Inserts a location object into database by id

Body_Parameters:

• name (str):

• The name of the location. Cannot match another location already inserted.

• description (str):

• The description of the location

• input_address (Optional[str]):

• Address of the location. Does not have to be full address. Must be provided if latitude and longitude are not provided

• latitude (Optional[str]):

• The latitude of the location being added. Must be provided with longitude if input_address is not.

• longitude (Optional[str]):

• The longitude of the location being added. Must be provided with latitude if input_address is not.

• project_id (str{guid}):

• The unique identifier for the project this location is inserted for

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostLocationsResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyLocationContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetLocationResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

LocationResource

Declaration

Task<GetLocationResourceResponseContext> GetLocationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int location_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns the Location by id

Returns:

• query_status (Dict):

• Contains key "status". If query succeeded

• location (Dict):

• Dictionary with location attributes

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetLocationResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	location_id
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutLocationResourceAsync(XperiflowSessionInfo, int, int, BodyLocationContext, MemoizedCacheInfo?, CancellationToken)

LocationResource

Declaration

Task<NullDataXperiflowResponseContext> PutLocationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int location_id, BodyLocationContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Updates or inserts a location object in database by id

Body_Parameters:

• name (str):

• The name of the location. Cannot match another location already inserted.

• description (str):

• The description of the location

• input_address (Optional[str]):

• Address of the location. Does not have to be full address. Must be provided if latitude and longitude are not provided

• latitude (Optional[str]): - The latitude of the location being added. Must be provided with longitude if input_address is not. - longitude (Optional[str]):

• The longitude of the location being added. Must be provided with latitude if input_address is not.

• project_id (str{guid}):

• The unique identifier for the project this location is inserted for

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	location_id
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyLocationContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteLocationResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

LocationResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteLocationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int location_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Deletes a location object in database by id

Body_Parameters:

• project_id (str{guid}):

• The unique identifier for the project this location is inserted for

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	location_id
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetRebuildsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

RebuildsResource

Declaration

Task<GetRebuildsResourceResponseContext> GetRebuildsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve 2 datatablecontexts for the given project id. These datatables will be useful for making rebuild decisions.

Returns:

• query_status (Dict) - If query was successful. - timestamps_data (DatatableContext) - Datatable containing past rebuild start/end times - message_data (DatatableContext) - Datatable containing ai bot messages regarding project performance and rebuild notifications

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetRebuildsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostRebuildsResourceAsync(XperiflowSessionInfo, int, ModelRebuildBodyContext, MemoizedCacheInfo?, CancellationToken)

RebuildsResource

Declaration

Task<PostRebuildsResourceResponseContext> PostRebuildsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, ModelRebuildBodyContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Post a new buildinfo for a rebuild

Body Parameters

Returns:

• project_id (str{guid})

• The project unique identifier - build_type (str) - Either "auto" or "manual". If auto, will use same configurations as latest build for targets being rebuilt

• buildfill_context (Dict{BuildFillInputContext})

• rebuild_type (str)

  • Either "full" or "partial". If "full", new features and targets may be added to the dataset. If "partial" only certain poor performing

targets will be rebuilt - partial_rebuild_option (Optional[str])

• One of "health_score", "bottom_performers", or "data_drift". Must only be provided if rebuild_type is "partial". If rebuild_type is

"full" this value must be null - data (Optional[float])

• Float to base the partial_rebuild_option off of. Must only be provided if rebuild_type is "partial". If rebuild_type is "full" this

value must be null.

• For "health_score" all targets with health score below data will be rebuilt.

• For "bottom_performers" the bottom percentage of targets based on health score will be rebuilt

• For "data_drift" all targets with data drift score below data will be rebuilt.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.PostRebuildsResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.ModelRebuildBodyContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPredictionsResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

PredictionsResource

Declaration

Task<GetPredictionsResourceResponseContext> GetPredictionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves prediction times and health scores for different prediction rounds.

Returns:

/* query_status (Dict)

/* If query was successful.

/* timestamps_data(DatatableContext)

/* Datatable containing information about each prediction round. Information includes starttime, endtime, status (running/completed).

/* forecast_range_step (int):

/* The forecast range of each forecasts

/* frequency_name (str):

/* The name of the frequency of the data

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPredictionsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetUploadOptionsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

UploadOptionsResource

Declaration

Task<GetUploadOptionsResourceResponseContext> GetUploadOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get available upload options by project id (provided in url)

• query_status (Dict)

• If query was successful.

• options (DatatableContext)

• Each row are the available options, schema, and associated job for different uploads

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetUploadOptionsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildAllowedModelsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildAllowedModelsResource

Declaration

Task<GetXperimentBuildAllowedModelsResourceResponseContext> GetXperimentBuildAllowedModelsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the Model Options given the provided Top Level XperimentBuildID. This will filter and provide only the Model Types that can be used for this xperiment build. It will filter by data points, and Pipeline Type.

Returns:

• query_status (Dict) - If query was successful. - model_options (DatatableContext) - Key/Value table with key as modelname to display to user and Value as modelname to provide back to engine within ppo_config POST if model is selected by user to run

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildAllowedModelsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildResource

Declaration

Task<GetXperimentBuildResourceResponseContext> GetXperimentBuildResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns information about the XperimentBuild requested

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildBacktestResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildBacktestResource

Declaration

Task<GetXperimentBuildBacktestResourceResponseContext> GetXperimentBuildBacktestResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve holdout backtest data in datatable format for a given target level xperimentbuild ID.

Returns:

• query_status (Dict) - If query was successful. - validation_run (bool) - If holdout backtest was run as part of pipeline and results are available. This is dependent on the amount of source data provided. - backtest_df (DatatableContext) - Each row is a model/date combination with predictions and actuals as different columns. Evaluationmetrics for the model are also provided in an additional column. This data can give a good example of how the models are expected to perform in a deployment setting.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildBacktestResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildEventAnalysisResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildEventAnalysisResource

Declaration

Task<GetXperimentBuildEventAnalysisResourceResponseContext> GetXperimentBuildEventAnalysisResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve insights of the events for a given target.

Returns:

• data (DatatableContext): Datatable with event statistics with each event as a different row

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildEventAnalysisResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildsResourceAsync(XperiflowSessionInfo, int, bool, IEnumerable<string>?, string?, int?, int?, string?, int?, IEnumerable<int>?, string?, MemoizedCacheInfo?, CancellationToken)

XperimentBuildsResource

Declaration

Task<GetXperimentBuildsResourceResponseContext> GetXperimentBuildsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, bool grouped, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, int? buildinfo_id = null, IEnumerable<int>? builinfo_ids = null, string? buildstate = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns DataFrame and state for the XperimentBuilds requested:

Parameter Relationships:

• Only 1 of BuildInfoID, BuildInfoIDs, and BuildState can specified in a query

• If all BuildInfoID, BuildInfoIDs, and BuildState are not specified, then all online XperimentBuilds will be retrieved.

Common Query Patterns:

• Pattern 1: By BuildInfo ID

• Gets the XperimentBuilds that are associated with this BuildInfoID

• Pattern 2: By BuildInfo IDs

• Gets the XperimentBuilds that are associated with these BuildInfoIDs

• Pattern 3: By BuildState

• Gets the only Online XperimentBuilds that are associated with the given BuildState specified ("train", "deploy")

• Pattern 4: No Specification

• Gets all Online XperimentBuilds.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Boolean	grouped
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
System.Nullable<System.Int32>	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.Int32>	builinfo_ids
System.String	buildstate
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildHealthResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

XperimentBuildHealthResource

Declaration

Task<GetXperimentBuildHealthResourceResponseContext> GetXperimentBuildHealthResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves the performance of the deployed models against the predictions that have been run over time. Returns all metrics

Returns:

• query_status (Dict) - If query was successful. - prediction_health(DatatableContext) - Dataframe containing the performance over the deployed models over time.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildHealthResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildPipelineConfigResource

Declaration

Task<GetXperimentBuildPipelineConfigResourceResponseContext> GetXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the Pipeline Parameter Object definitions for a particular XperimentBuild (target or groups of targets).

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildPipelineConfigResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo, int, int, BodyPpoContext, MemoizedCacheInfo?, CancellationToken)

XperimentBuildPipelineConfigResource

Declaration

Task<NullDataXperiflowResponseContext> PutXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, BodyPpoContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Body parameters:

• project_id

• ppo_config

• auto_include_baselines

URL parameters:

• xperimentbuild_id

Description

Build a custom Pipeline Parameter Object (PPO) config file. This Post request will either create the PPO Config or update the existing PPO config for the given xperiment build ID that is provided as a url parameter. Note that the auto.use_auto_modeling will automatically be hard set to False upon posting. This is so that the engine is notified not to do Auto Modeling for this particular PPO config. Passing in auto_include_baselines=True will automatically include the baselines corresponding to the stype of the xperimentbuild if no baselines were already present.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyPpoContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildPipelineConfigResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

XperimentBuildPipelineConfigResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildSelectedFeaturesAnalysisResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildSelectedFeaturesAnalysisResource

Declaration

Task<GetXperimentBuildSelectedFeaturesAnalysisResourceResponseContext> GetXperimentBuildSelectedFeaturesAnalysisResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve insights of the selected features for a given target.

Returns:

• statistics (DatatableContext): Datatable with feature selection statistics

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildSelectedFeaturesAnalysisResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildSelectedFeaturesResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildSelectedFeaturesResource

Declaration

Task<GetXperimentBuildSelectedFeaturesResourceResponseContext> GetXperimentBuildSelectedFeaturesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a dictionary of feature selection statistics and a DataTable of selected features for a given targetlevel xperimentbuild ID

Returns:

• query_status (Dict) - If query was successful. - statistics (Dict) - total_features_created (int)

  • Total number of features created for the given target.

• total_created_numerical_features (int) - total_created_categorical_features (int) - total_features_selected (int)

  • Total number of features selected to be used in modeling for the given target.

• total_selected_numerical_features (int) - total_selected_categorical_features (int) - selected_features (DataTableContext): - All of the selected features for the given target

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildSelectedFeaturesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildTrainingResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildTrainingResource

Declaration

Task<GetXperimentBuildTrainingResourceResponseContext> GetXperimentBuildTrainingResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve training data for a given target level xperimentbuild ID. If there is a validation split (part used to select best hyperparameters), that section of the split is used, otherwise, the train section of the split is used.

Returns:

• query_status (Dict) - If query was successful. - statistics(Dict) - total_models (int)

  • Total number of models trained for given xperimentbuild

• average_evaluationmetric_score (float)

  • evaluationmetric scores averaged across all models for the given target

• best_model (str)

  • The model with the best validation (or train) split evaluationmetric score for the given target

• best_evaluationmetric_score (float

  • The value of the evaluationmetric score for the best_model

• training_df (DatatableContext) - Datatable containing the predicted values for each model on the validation or train section of the largest split

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildTrainingResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildTemporalAnalysisResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentBuildTemporalAnalysisResource

Declaration

Task<GetXperimentBuildTemporalAnalysisResourceResponseContext> GetXperimentBuildTemporalAnalysisResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve insights of the time for a given target.

Returns:

• query_status (Dict)

• If query was successful.

• statistics (Dict)

• Datatable with insights for different time breakdowns (day of week, week of year, etc.)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildTemporalAnalysisResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildsAuditResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

XperimentBuildsAuditResource

Declaration

Task<GetXperimentBuildsAuditResourceResponseContext> GetXperimentBuildsAuditResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves a JSON DataTable of XperimentBuild related information. Each record in this JSON DataTable corresponds to an online XperimentBuild.

Response DataTable Columns:

• UseAutoModeling (bool): If XperimentBuild used automodeling

• AllowNegativeTargets (bool): If XperimentBuild allowed negatives

• DeployStrategy (str): The deployment strategy of this XperimentBuild ('best', 'best_three', 'all')

• ModelingContext (ModelingContext): Details on models run for XperimentBuild

• FeatureSelectionContext (FeatureSelectionContext): Details on feature selection run for XperimentBuild

• TotalModels (int): Total models run through pipeline for XperimentBuild

• TotalTrainTime (int): Total seconds spent running models for XperimentBuild. This includes training/softtrain/prediction time. Also, time in parallel is counted for totals. For example: If 1 min was spent on 2 separate processes at the same time, the total train time is 2 min.

• CurrentBestModel (str): The name of the best deployed model for the XperimentBuild. Based on PipelineRank

• TotalFeatures (int): The total features generated for the XperimentBuild

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildsAuditResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildsFilterResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, string?, MemoizedCacheInfo?, CancellationToken)

XperimentBuildsFilterResource

Declaration

Task<GetXperimentBuildsFilterResourceResponseContext> GetXperimentBuildsFilterResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, string? filterer = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get df of target names and xperiment build ids given the type we want (auto: give all auto ppo targets, manual: give all non auto ppo targets, all: give all targets)

Input:

Project_id, xperimentinfo_id, filterer(all, auto, manual)

Returns:

Get paginated df of targets and xperiment build ids based on the given group

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildsFilterResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
System.String	filterer	str: The method to filter the XperimentInfo results. Must be one of all, manual, or auto.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentSetPredictionResultsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

XperimentSetPredictionResultsResource

Declaration

Task<GetXperimentSetPredictionResultsResourceResponseContext> GetXperimentSetPredictionResultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentset_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Provide 2 datatables for analysis of prediction results for various deployed models. This API runs on a target by target basis with a given xperimentset_id.

Returns:

• query_status (Dict)

• If query was successful.

• datatable (DatatableContext)

• Datatable containing predictions vs. actuals for various models on each date of predictions. Each row is a date/model combination

with predictions and actuals as different columns. * model_metrics (DatatableContext)

• Datatable with each row containing the metric value for a given model along with the model ID. This can be used for an overview

of how the model is currently performing. This metric is over the course of all predictions since the most recent model build for the given target. Pipeline predictions are also included with the dataset type that was used for model selection.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentSetPredictionResultsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentset_id	the unique identifier associated with the xperimentset.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourcesConnectionsResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

DataSourcesConnectionsResource

Declaration

Task<GetDataSourcesConnectionsResourceResponseContext> GetDataSourcesConnectionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves DataSource Connection Information that associated to the provided project ID.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourcesConnectionsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetCustomCrossValidationModelRunResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

CustomCrossValidationModelRunResource

Declaration

Task<GetCustomCrossValidationModelRunResourceResponseContext> GetCustomCrossValidationModelRunResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Given the buildinfo id and project id, will return the custom model run schema and custom cross validation schema for that given buildinfo and project

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetCustomCrossValidationModelRunResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutCustomCrossValidationModelRunResourceAsync(XperiflowSessionInfo, int, int, BodyCvModelRunContext, MemoizedCacheInfo?, CancellationToken)

CustomCrossValidationModelRunResource

Declaration

Task<NullDataXperiflowResponseContext> PutCustomCrossValidationModelRunResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyCvModelRunContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Updates the custom cv and custom model run for the provided buildinfo ID

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyCvModelRunContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDatatableIndexResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

DatatableIndexResource

Declaration

Task<GetDatatableIndexResourceResponseContext> GetDatatableIndexResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Return a list of the indices of the source datatable

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDatatableIndexResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetCrossValidationGuardrailsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

CrossValidationGuardrailsResource

Declaration

Task<GetCrossValidationGuardrailsResourceResponseContext> GetCrossValidationGuardrailsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a dictionary of the guardrails for setting the cross validation strategy

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetCrossValidationGuardrailsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetCustomModelRunPortionsResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

CustomModelRunPortionsResource

Declaration

Task<GetCustomModelRunPortionsResourceResponseContext> GetCustomModelRunPortionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns the portions of splits required to be filled out when setting the custom cross validation strategy

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetCustomModelRunPortionsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetCleanMethodsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

CleanMethodsResource

Declaration

Task<GetCleanMethodsResourceResponseContext> GetCleanMethodsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the list of current cleaning methods available Returns: - clean_methods: List/[str/]

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetCleanMethodsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutCrossValidationResetDefaultResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

CrossValidationResetDefaultResource

Declaration

Task<NullDataXperiflowResponseContext> PutCrossValidationResetDefaultResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

CrossValidationResetDefaultResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetDataSourceMissingValuesResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

DataSourceMissingValuesResource

Declaration

Task<GetDataSourceMissingValuesResourceResponseContext> GetDataSourceMissingValuesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

DataSourceMissingValuesResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetDataSourceMissingValuesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPredictionCallResourceAsync(XperiflowSessionInfo, int, int, MemoizedCacheInfo?, CancellationToken)

PredictionCallResource

Declaration

Task<GetPredictionCallResourceResponseContext> GetPredictionCallResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int prediction_call_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a given prediction call executed for the project.

Returns:

• query_status: QueryStatusContext

• schedule_start_time (datetime): The scheduled start time of the prediction

• start_time (datetime): The start time of the prediction

• end_time (datetime): The end time of the prediction

• prediction_type (str): The type of prediction (auto/manual)

• source_call_id (Guid)

• job_id (int): The job id associated with the prediction

• forecast_start_date (datetime): The forecast start date of the prediction (first forecasted date)

• forecast_num (int): The forecast number at the given forecsat start date (starts at 1)

• forecast_name (str): The customizable forecast name associated with the prediction call

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPredictionCallResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	prediction_call_id	the unique identity associated with the prediction_call.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutPredictionCallResourceAsync(XperiflowSessionInfo, int, int, BodyPredictionCallContext, MemoizedCacheInfo?, CancellationToken)

PredictionCallResource

Declaration

Task<NullDataXperiflowResponseContext> PutPredictionCallResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int prediction_call_id, BodyPredictionCallContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Modifies the forecast name of a given prediction call.

Body Params:

• forecast_name (str): The desired forecast name. Must be less than 200 characters

Returns:

• prediction_call_id (integer): prediction call id to be modified

• message (str): Message to inform user

• modified (bool): If modification was successfull or not

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	prediction_call_id	the unique identity associated with the prediction_call.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyPredictionCallContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetPredictionCallsResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

PredictionCallsResource

Declaration

Task<GetPredictionCallsResourceResponseContext> GetPredictionCallsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get the list of prediction calls executed for a project and the current forecast date if a forecast were to be run immediately without updating source data

Returns:

• predictioncalls_df: DataTableContext

• current_forecast_date (datetime):

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetPredictionCallsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetColumnDataResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

ColumnDataResource

Declaration

Task<GetColumnDataResourceResponseContext> GetColumnDataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

ColumnDataResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetColumnDataResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentBuildModelRunSchemaResourceAsync(XperiflowSessionInfo, int, int, string?, MemoizedCacheInfo?, CancellationToken)

XperimentBuildModelRunSchemaResource

Declaration

Task<GetXperimentBuildModelRunSchemaResourceResponseContext> GetXperimentBuildModelRunSchemaResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, string? model_stage = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

XperimentBuildModelRunSchemaResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentBuildModelRunSchemaResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
System.String	model_stage	str: The modelstage to retrieve the modelrunschema for.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetXperimentKernelsResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

XperimentKernelsResource

Declaration

Task<GetXperimentKernelsResourceResponseContext> GetXperimentKernelsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

XperimentKernelsResource

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetXperimentKernelsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	xperimentbuild_id	the unique identifier associated with the xperimentbuild.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetEventsAssignmentCountResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

EventsAssignmentCountResource

Declaration

Task<GetEventsAssignmentCountResourceResponseContext> GetEventsAssignmentCountResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

StartFragment

Retrieve a datatable showing the number of targets assigned to each event for a given buildinfo id.

Returns: - query_status (Dict)

• If query was successful.

• filterable_data (DatatableContext)

  • 3 columns: EventID, EventName, TargetCount

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetEventsAssignmentCountResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetLocationsAssignmentCountResourceAsync(XperiflowSessionInfo, int, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

LocationsAssignmentCountResource

Declaration

Task<GetLocationsAssignmentCountResourceResponseContext> GetLocationsAssignmentCountResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

StartFragment

Retrieve a datatable showing the number of targets assigned to each locationfor a given buildinfo id.

Returns: - query_status (Dict)

• If query was successful.

• filterable_data (DatatableContext)

  • 3 columns: LocationID, LocationName, TargetCount

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetLocationsAssignmentCountResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Int32	buildinfo_id	the unique identifier associated with the buildinfo.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetJobCheckpointResourceAsync(XperiflowSessionInfo, int, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, CancellationToken)

JobCheckpointResource

Declaration

Task<GetJobCheckpointResourceResponseContext> GetJobCheckpointResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the options of possible checkpoints to revert to. These checkpoints are to be used in conjunction with the post of the RestartJob with the JobsResource. The checkpoints will be available checkpoints from the latest buildinfo. If the buildinfo is offline and a manual build then no checkpoints will be offered. Also if the buildinfo doesn't have any buildinfostates then this api will return query status False. Note: While a restart job is running, other apis should not be getting hit due to the project db getting replaced. Also, once a checkpoint is restored to, other checkpoints are then lost (but can restore to the same checkpoint multiple times in a row).

Additional Notes:

• Checkpoints are only valid for 7 days from when they were created.

• Checkpoints can only be used for the project with which they were created (Relevant for projects that are copied).

Returns:

• query_status (Dict)

• If query was successful.

• job_checkpoint_datatable(DatatableContext)

• Table containing possible checkpoints to revert the project to. There are 5 columns included in this table:

  • ID: Checkpoint ID that would be fed into the Restart Job

  • RoutineType: The name of the routine of the checkpoint

  • StartTime: Time at which the checkpoint ran

  • FKJobActivityID: Job unique identifier of the job that the checkpoint corresponds to.

  • Alias: The alias for the routine type

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.GetJobCheckpointResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	project_id	The unique identifier associated with the project.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.