Interface IXperiflowTimeSeriesForecastingClient

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

Assembly: Xperiflow.dll

Declaration

public interface IXperiflowTimeSeriesForecastingClient

Methods

GetAggregationTypeOptionsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, int[], CancellationToken)

AggregationTypeOptionsResource

Declaration

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

Remarks

Retrieve the list of available aggregation type options that can be used for data processing and feature aggregation operations.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

FrequencyOverridesOptionsResource

Declaration

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

Remarks

Retrieve the list of available frequency override options that can be used to override default time series frequencies for data processing.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

MLTypeOptionsResource

Declaration

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

Remarks

Retrieve the list of available machine learning problem type options including regression, classification, and clustering.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

TuningStrategiesResource

Declaration

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

Remarks

Retrieve the list of available hyperparameter tuning strategies in Xperiflow.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ModelCollectionResource

Declaration

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

Remarks

Retrieve a collection of all available Xperiflow model types with their metadata including name, parent class, and class attributes. Supports optional filtering via Pinq query expressions.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

MetricCollectionResource

Declaration

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

Remarks

Retrieve a collection of all available evaluation metrics with their metadata including name, parent class, and attributes. Supports optional filtering via Pinq query expressions.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

TransformerCollectionResource

Declaration

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

Remarks

Retrieve metadata for all available data transformers including their names, parent classes, and attributes. Supports filtering via Pinq query expressions to find specific transformer types or implementations.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

SelectionAlgorithmCollectionResource

Declaration

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

Remarks

Retrieve metadata for all available feature selection algorithms including their names, parent classes, and attributes. Supports filtering via Pinq query expressions to find specific algorithm types or implementations.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoAssignmentsGeneratorsResource

Declaration

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

Remarks

Assign event generator and location configurations to XperimentBuilds within a BuildInfo for feature generation.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

PipelineConfigResource

Declaration

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

Remarks

Reset all pipeline parameter configurations for a BuildInfo to use automatic modeling settings instead of manual configurations.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoAssignmentsLocationsResource

Declaration

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

Remarks

Assign location IDs to all target-level XperimentBuilds within a BuildInfo, enabling batch configuration of location-based forecasting for multiple models.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve count of event generators and locations assigned to each target-level experiment build for a BuildInfo with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve available generators and their assignment status for a target-level XperimentBuild with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildAssignmentsGeneratorsResource

Declaration

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

Remarks

Assign generator configuration IDs to a target-level (not group-level) XperimentBuild.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildsAssignmentsGeneratorsResource

Declaration

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

Remarks

Batch assign multiple event generators or features to multiple XperimentBuilds, enabling efficient configuration of event-based features across model variants.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildAssignmentsLocationsResource

Declaration

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

Remarks

Retrieve available locations and currently assigned locations for a 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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildAssignmentsLocationsResource

Declaration

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

Remarks

Assign a list of location IDs to a target-level XperimentBuild.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildsAssignmentsLocationsResource

Declaration

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

Remarks

Assign specific location IDs to a target-level XperimentBuild, enabling location-based forecasting and model execution for hierarchical or multi-location scenarios.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

AttachDatabaseResource

Declaration

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

Remarks

Create a new project by connecting to an existing database, providing project name, description, application, database configuration, and problem type characteristics. Validates database version compatibility before creation.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

AutoConfigResource

Declaration

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

Remarks

Retrieve auto-modeling configuration including train duration estimates, deployment strategy, negative target handling, missing data cleaning method, and evaluation metric.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

AutoConfigResource

Declaration

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

Remarks

Update auto-modeling configuration including train inflation factor, negative target handling, deployment strategy, missing data method, horizon optimization, and evaluation metric.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

AutoConfigSummaryResource

Declaration

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

Remarks

Retrieve summary statistics showing the count of targets using automatic modeling configuration versus manual configuration.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve BuildInfo attributes including status, timestamps, ML class type, build type/state, mutability, online status, and configuration. Supports querying by ID, latest BuildInfo, or latest by build state (train/deploy).

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoArchiveResource

Declaration

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

Remarks

Archive a build info and its experiment builds to offline status, optionally creating a new build info with the same buildfill configuration. Requires completed dataload and finished state.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoAuditResource

Declaration

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

Remarks

Retrieve a comprehensive audit table of all deployed model builds with detailed configuration including forecast ranges, cross-validation strategies, feature processing settings, target statistics, grouping information, and hierarchical configurations for compliance and tracking purposes.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoBacktestResource

Declaration

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

Remarks

Retrieve pipeline run summary including deployed model counts, pipeline statistics, win margins comparing best models to baselines, and VM CPU utilization over time.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoConfigResource

Declaration

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

Remarks

Retrieve the feature engineering configuration for a model build including settings for feature generation, transformation, selection, and grouping with their respective computational thresholds.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoConfigResource

Declaration

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

Remarks

Update the feature engineering configuration for a model build including settings for feature generation, transformation, selection, and grouping with their respective computational 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.BodyBuildinfoConfigContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoConfigResource

Declaration

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

Remarks

Reset the feature engineering configuration for a model build to default values.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ModelThresholdsConfigResource

Declaration

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

Remarks

Retrieve the model performance thresholds configuration for the buildinfo.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ModelThresholdsConfigResource

Declaration

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

Remarks

Update the model performance thresholds configuration for the 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.Core.RestApi.TimeSeriesForecasting.BodyModelThresholdsContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ModelThresholdsConfigResource

Declaration

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

Remarks

Reset the model performance thresholds configuration to default values.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

HierarchyConfigResource

Declaration

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

Remarks

Retrieve the hierarchical forecasting configuration for the buildinfo.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

HierarchyConfigResource

Declaration

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

Remarks

Update the hierarchical forecasting configuration for the 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.Core.RestApi.TimeSeriesForecasting.BodyHierarchyConfigContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

HierarchyConfigResource

Declaration

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

Remarks

Delete the hierarchical forecasting configuration for the 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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve build information for model training runs including ID, start/end times, build type, build state, and target counts. Supports optional inclusion of offline builds with pagination and filtering.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve build info pipeline state progress including completion status, activity status, and underlying job/task identifiers. Supports querying by build info ID, latest buildinfo, or latest by build state (train/deploy).

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildSummaryResource

Declaration

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

Remarks

Retrieve build summary statistics including target counts, groups, models trained, hyperparameter tuning iterations, and features generated for a specific BuildInfo.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

CrossValidationSplitsResource

Declaration

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

Remarks

Retrieve cross-validation split configurations for a build info, including the strategy type and list of split definitions.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ConsumptionGroupResource

Declaration

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

Remarks

Retrieve a specific consumption group configuration by ID, defining how predictions are consumed and aggregated.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ConsumptionGroupResource

Declaration

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

Remarks

Update a consumption group configuration.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ConsumptionGroupResource

Declaration

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

Remarks

Delete a consumption group configuration by 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	consumption_id	The unique identifier associated with the consumption group.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ConsumptionGroupsResource

Declaration

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

Remarks

Retrieve all consumption group configurations for the project, which define how model predictions and related data are consumed and delivered to downstream systems or external tables.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ConsumptionGroupsResource

Declaration

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

Remarks

Create a new consumption group configuration specifying the group type, output table, time range, extraction type, and which models to include for data consumption and delivery to downstream systems.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ConsumptionPBMResource

Declaration

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

Remarks

Create a new consumption workflow through parameter-by-model interface for configuring how predictions and model outputs are consumed and delivered.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve exploratory data analysis for source dataset including column statistics and timeseries data. Supports returning column data only or specific column details.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve filterable column metadata for data exploration including series types, ML types, and available filtering options with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

BuildInfoAssignmentsSummaryResource

Declaration

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

Remarks

Retrieve location and generator assignment statistics for a specific BuildInfo.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GeneratorPackagesApplyResource

Declaration

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

Remarks

Apply generator packages to a buildinfo, configuring feature generation from event packages with specified transformation types, scenario settings, and feature selection bypass options.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve feature effect statistics showing how different feature values impact model predictions and target averages. Returns statistics for specified models, including feature names, value ranges, and corresponding prediction and target average values.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve all generated features for a build info, with each feature represented as a row, including pagination and filtering support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

FeaturesGeneratedDatatypesResource

Declaration

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

Remarks

Retrieve statistics on generated feature data types showing the count of features for each data type within a BuildInfo.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve feature impact statistics showing how important each feature is to model predictions. Returns feature names with their impact scores for specified models.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

FeatureTransformersDistributionResource

Declaration

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

Remarks

Retrieve feature transformer usage statistics showing the count of features using each transformer type for a specific BuildInfo.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

FeaturesSummaryResource

Declaration

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

Remarks

Retrieve feature engineering summary statistics for a BuildInfo, including counts of unique generated and selected features, selection rounds, transformation rounds, and feature engineering duration.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GlobalFeatureGeneralizationResource

Declaration

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

Remarks

Retrieve global feature generalization statistics showing how features are utilized across targets, including eligibility counts, utilization rates, and percentage metrics for feature effectiveness analysis.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ForecastResource

Declaration

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

Remarks

Retrieve forecast configuration including range step (forecast horizon) and collection lag step (data lag).

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ForecastResource

Declaration

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

Remarks

Update forecast configuration by setting range step (forecast horizon datapoints) and collection lag step (data source lag).

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ForecastOptionsResource

Declaration

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

Remarks

Retrieve available forecast step options for configuring prediction horizons.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ForecastInfoResource

Declaration

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

Remarks

Retrieve the forecast configuration information including horizon, frequency, and range settings for the buildinfo.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GroupingResource

Declaration

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

Remarks

Retrieve the grouping methodology configuration for targets, supporting strategies like significance-based grouping, clustering, dimensions, uniform, or no grouping with optional cross-hierarchy grouping.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GroupingResource

Declaration

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

Remarks

Create or update the grouping configuration for targets in a build info, defining how targets should be grouped together for modeling.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GroupingOptionsResource

Declaration

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

Remarks

Retrieve available grouping configuration options for a project, returned as key-value pairs for hierarchical grouping setup.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GeneratorCompatibilityResource

Declaration

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

Remarks

Retrieve all available event generators with their compatibility status and usage information for a specific BuildInfo.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve configured event generators for a build info, showing each generator configuration as a row with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GeneratorConfigurationsResource

Declaration

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

Remarks

Create an event generator configuration for a buildinfo, specifying fit parameters, feature selection bypass settings, scenario feature designation, and optional description for custom event-based feature generation.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GeneratorConfigurationsResource

Declaration

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

Remarks

Delete all custom generator configurations for a buildinfo, resetting to pipeline default generator configurations.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GeneratorConfigurationsBulkDeleteResource

Declaration

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

Remarks

Delete multiple generator configurations from a BuildInfo in a single bulk operation.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Update an event generator configuration with new initialization parameters or settings. Parameters are validated against generator requirements.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GeneratorConfigurationResource

Declaration

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

Remarks

Delete a specific event generator configuration.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

GroupingTargetDistributionResource

Declaration

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

Remarks

Retrieve grouped target distribution showing each group broken down by significance and target count, with single series treated as groups for comparison.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve forecasting scenarios created for a build info with pagination support. Scenarios enable what-if analysis and alternative forecast generation.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ScenariosResource

Declaration

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

Remarks

Create a new forecasting scenario with a specified name, description, and forecast start date for what-if analysis or alternative forecasts.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the features and their values configured for a specific forecasting scenario with pagination, filtering, and sorting support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ScenarioResource

Declaration

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

Remarks

Update an existing forecasting scenario's name and description metadata.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ScenarioResource

Declaration

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

Remarks

Delete a forecasting scenario and all its associated feature configurations.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the data values for a specific feature within a forecasting 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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ScenarioFeatureDataResource

Declaration

Task<NullDataXperiflowResponseContext> PutScenarioFeatureDataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, int scenario_id, ScenarioFeatureDataBodyContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = 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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve feature values used in predictions for specified prediction calls and experiment builds. Supports optional date range filtering to focus on specific time periods. Returns feature names, values, and associated dates.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentKernelResource

Declaration

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

Remarks

Retrieve detailed information about a specific experiment kernel including model configuration, hyperparameters, and training details.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve metadata for trained models including name, stage, baseline status, evaluation metrics, and pipeline ranking. Supports filtering by experiment build, experiment kernel, model stage, and deployment status with pagination and sorting.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve evaluation metrics for pipeline model stages including training, validation, and backtesting. Supports filtering by model stage, dataset type, data splits, and metric types via Pinq queries.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve timeseries prediction data from pipeline models, including forecasts, prediction intervals, and actual values for comparison and visualization. Supports filtering by model stage, dataset type, and data splits, with configurable merging of overlapping predictions.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve prediction metrics for deployed models, optionally aggregated across predictions or filtered by forecast date and prediction call. Supports filtering by model selection and metric types via Pinq queries.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve timeseries prediction data from deployed models with options to merge overlapping forecasts, include prior actual data, and filter by prediction calls. Automatically selects best model when not specifying models explicitly.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve prediction explanations showing feature contributions to model predictions. Returns explanation data with feature importance values, filtered by model stage, dataset type, and splits. Not available for baseline models.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ProjectResource

Declaration

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

Remarks

Retrieve project definition information including name, description, application, database configuration, and problem type characteristics (ptype, ttype, vtype).

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ProjectResource

Declaration

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

Remarks

Update project information including name, description, and access permissions for viewer, editor, and manager identities.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

ProjectResource

Declaration

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

Remarks

Delete the project and initiate a background job to remove the associated database. Returns the job ID for tracking the deletion process.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the list of Xperiflow projects with optional filtering by problem type (ptype), time type (ttype), vised type (vtype), or application name.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

RebuildOptionsTypeResource

Declaration

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

Remarks

Retrieve available rebuild type options (auto-modeling or manual configuration).

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

HierarchySourceDataMetricsResource

Declaration

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

Remarks

Retrieve the source data metrics artifact for a specific hierarchy within a buildinfo, providing aggregated statistics and performance measures for the hierarchical structure.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

RebuildOptionsFillResource

Declaration

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

Remarks

Retrieve available rebuild fill type options (full or partial rebuild).

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

RebuildOptionsFillPartialResource

Declaration

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

Remarks

Retrieve available partial rebuild methods including health-based and performance-based selection options.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

RebuildOptionsFillPartialNumbersResource

Declaration

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

Remarks

Retrieve numerical parameter options for partial rebuild strategies, such as health thresholds or bottom performer percentages.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

TargetSummaryResource

Declaration

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

Remarks

Retrieve summary statistics for targets in a build info including counts, distributions, and hierarchical breakdowns.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

TargetSignificanceResource

Declaration

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

Remarks

Retrieve target significance distribution data in 1-percentile increments showing relative importance of targets and total target count for a build info.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve attribute definitions for a specific data source, including feature configuration and metadata.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceAttributesResource

Declaration

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

Remarks

Update attribute definitions for a specific data source, modifying feature configuration and metadata settings.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceConnectionResource

Declaration

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

Remarks

Retrieve the connection configuration and metadata for a specific data source including connection strings, credentials, and access settings.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceDataFormResource

Declaration

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

Remarks

Retrieve the data form configuration and metadata for a specific data source, including the form structure, field types, and validation rules for data input and processing.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceDataFormSummaryResource

Declaration

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

Remarks

Retrieve data source statistics including frequency distribution, date ranges, and aggregation counts for time series analysis and configuration.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceFeatureCommitPBMResource

Declaration

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

Remarks

Initiate a feature data validation workflow job. Returns job identifier for tracking the feature data commit and validation process.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceCommitResource

Declaration

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

Remarks

Commit a feature data source to a buildinfo, making it available for model training. Only allowed in specific build states.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceCommitResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteDataSourceCommitResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, string datasource_name, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = 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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourcesCommitResource

Declaration

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

Remarks

Batch commit multiple feature data sources to a buildinfo, making them available for model training. Only allowed in specific build states.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = 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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve all data source form configurations for the project with pagination, filtering by form type, and sorting support.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve feature data source attributes for a BuildInfo, including configuration flags for known-in-advance features, feature selection bypass, feature engineering permissions, and commitment status. Supports pagination, filtering, and sorting.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = 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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceResource

Declaration

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

Remarks

Delete a feature data source by name. Cannot delete target data sources or data sources committed to online buildinfos.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceSnapshotCollectionLagsResource

Declaration

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

Remarks

Retrieve collection lag distribution statistics for a data source snapshot, showing bin names with distribution and cumulative vectors. Supports online (from current time) or offline (from latest data time) lag calculation.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceSnapshotMessagesResource

Declaration

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

Remarks

Retrieve data quality health messages and validation warnings for a specific data source snapshot, helping identify issues in the ingested data.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourcesSnapshotsResource

Declaration

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

Remarks

Retrieve data source snapshot statistics showing refresh history, execution times, and data collection status.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourcesSnapshotsExecutionTimesResource

Declaration

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

Remarks

Retrieve datasource snapshot execution times showing when data refresh operations were performed.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceTargetResource

Declaration

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

Remarks

Retrieve connection and data form configuration for the project's target data source, including database details and data structure.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceTargetCommitPBMResource

Declaration

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

Remarks

Initiate a target data validation workflow job. Returns job identifier for tracking the target data commit and validation process.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceUpdatePBMResource

Declaration

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

Remarks

Initiate a data source update workflow job. Returns job identifier for tracking the data source refresh process.

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.Int32[]	mutedStatusCodes
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.

PostDataSourcesRefreshPBMResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, int[], CancellationToken)

DataSourcesRefreshPBMResource

Declaration

Task<PostDataSourcesRefreshPbmResourceResponseContext> PostDataSourcesRefreshPBMResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Initiate a data sources refresh workflow job. Returns job identifier for tracking the refresh process across all data sources.

Returns

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

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

HierarchyTargetStatResource

Declaration

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

Remarks

Retrieve statistics showing the number of forecast targets for each combination in the hierarchical structure of the 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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DeploymentSummaryResource

Declaration

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

Remarks

Retrieve deployment statistics including counts of targets, single targets, groups, and combined target types in utilization, along with the timestamp of the most recent prediction.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

HealthResource

Declaration

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

Remarks

Retrieve project health metrics for rebuild decision-making, including healthscore distribution data for binning targets and performance statistics. Provides insights into model drift and overall project health.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

HealthSummaryStatisticsResource

Declaration

Task<GetHealthSummaryStatisticsResourceResponseContext> GetHealthSummaryStatisticsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve aggregated project health statistics including average model metrics across targets, model usage counts, evaluation metric distributions, and dataset type breakdowns.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve locations for a project with pagination and filtering support. Returns location details including name, description, address, and geographic coordinates.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

LocationsResource

Declaration

Task<PostLocationsResourceResponseContext> PostLocationsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, BodyLocationContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Create a new location for a project by providing a unique name, description, and either an address or latitude/longitude coordinates. Location names must be unique within the project.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

LocationResource

Declaration

Task<GetLocationResourceResponseContext> GetLocationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int location_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve a specific location by ID including its name, description, address, and geographic coordinates.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

LocationResource

Declaration

Task<NullDataXperiflowResponseContext> PutLocationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int location_id, BodyLocationContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Update a location's details including name, description, and location data (either address or latitude/longitude). Location names must remain unique within the 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.
System.Int32	location_id
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyLocationContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

LocationResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteLocationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int location_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Delete a specific location from the project by 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	location_id
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

RebuildsResource

Declaration

Task<GetRebuildsResourceResponseContext> GetRebuildsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve rebuild history and AI-generated notifications for making rebuild decisions. Returns past rebuild timestamps and performance messages.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

RebuildsResource

Declaration

Task<PostRebuildsResourceResponseContext> PostRebuildsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, ModelRebuildBodyContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Create a new model rebuild job, either full (with new features/targets) or partial (targeting poor performers based on health score, bottom performers percentage, or data drift). Returns created build info ID.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve prediction job history including forecast names, queued/start/end times, scheduled status, and health scores. Returns forecast range and data frequency information with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

UploadOptionsResource

Declaration

Task<GetUploadOptionsResourceResponseContext> GetUploadOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve available upload options including schemas and associated jobs for different data upload types.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildAllowedModelsResource

Declaration

Task<GetXperimentBuildAllowedModelsResourceResponseContext> GetXperimentBuildAllowedModelsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve allowed model types for an experiment build, filtered by available data points and pipeline type. Returns display names and engine identifiers for PPO configuration.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildResource

Declaration

Task<GetXperimentBuildResourceResponseContext> GetXperimentBuildResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve detailed information about a specific XperimentBuild including configuration, status, and metadata.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildBacktestResource

Declaration

Task<GetXperimentBuildBacktestResourceResponseContext> GetXperimentBuildBacktestResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve holdout backtest results showing model predictions versus actuals with evaluation metrics. Each row represents a model-date combination, providing insight into expected deployment performance when sufficient source data exists.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildEventAnalysisResource

Declaration

Task<GetXperimentBuildEventAnalysisResourceResponseContext> GetXperimentBuildEventAnalysisResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve event statistics and insights for a target's experiment build, with each row representing a different event.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve XperimentBuilds for a project with flexible filtering by BuildInfo ID(s), build state (train/deploy), or grouped hierarchical data. Returns all online XperimentBuilds when no filters are specified, with support for pagination and sorting.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve deployed model performance metrics over time, showing how predictions compare to actuals across prediction runs with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildPipelineConfigResource

Declaration

Task<GetXperimentBuildPipelineConfigResourceResponseContext> GetXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the Pipeline Parameter Object (PPO) configuration for an XperimentBuild, defining modeling settings, feature generation, and algorithm choices.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildPipelineConfigResource

Declaration

Task<NullDataXperiflowResponseContext> PutXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, BodyPpoContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Create or update a custom Pipeline Parameter Object (PPO) configuration for an XperimentBuild, disabling auto-modeling. Optionally include baseline models automatically.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildPipelineConfigResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteXperimentBuildPipelineConfigResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Delete the custom Pipeline Parameter Object configuration for an XperimentBuild, reverting to default auto-modeling behavior.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildSelectedFeaturesAnalysisResource

Declaration

Task<GetXperimentBuildSelectedFeaturesAnalysisResourceResponseContext> GetXperimentBuildSelectedFeaturesAnalysisResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve analytical insights and statistics about the feature selection process for a target's experiment build.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildSelectedFeaturesResource

Declaration

Task<GetXperimentBuildSelectedFeaturesResourceResponseContext> GetXperimentBuildSelectedFeaturesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve selected features for a target's experiment build with statistics on total created features (numerical/categorical) and total selected features used in modeling.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildTemporalAnalysisResource

Declaration

Task<GetXperimentBuildTemporalAnalysisResourceResponseContext> GetXperimentBuildTemporalAnalysisResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve temporal patterns and insights for a target including time breakdowns by day of week, week of year, and other time-based analysis dimensions.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve audit information for online experiment builds including automodeling usage, deployment strategy, total models/features/training time, modeling configuration, and current best model with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve filtered list of targets and their experiment build IDs by build type (auto, manual, or all) for a specific build info with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentSetPredictionResultsResource

Declaration

Task<GetXperimentSetPredictionResultsResourceResponseContext> GetXperimentSetPredictionResultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentset_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve prediction analysis for deployed models in an experiment set, providing two datatables: one with predictions versus actuals by date and model, and another with cumulative performance metrics for each model since the most recent build.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve data source connection information for all data sources associated with a project, with pagination and filtering support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

CustomCrossValidationModelRunResource

Declaration

Task<GetCustomCrossValidationModelRunResourceResponseContext> GetCustomCrossValidationModelRunResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the custom model run schema and custom cross-validation schema configuration for a specific buildinfo, allowing inspection of training and validation strategies.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

CustomCrossValidationModelRunResource

Declaration

Task<NullDataXperiflowResponseContext> PutCustomCrossValidationModelRunResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, BodyCvModelRunContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Update the custom cross-validation and model run configuration for a buildinfo, modifying training and validation strategies.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DatatableIndexResource

Declaration

Task<GetDatatableIndexResourceResponseContext> GetDatatableIndexResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the list of index columns configured for the source data table used in the buildinfo.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

CrossValidationGuardrailsResource

Declaration

Task<GetCrossValidationGuardrailsResourceResponseContext> GetCrossValidationGuardrailsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve validation constraints and guardrails for configuring 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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

CustomModelRunPortionsResource

Declaration

Task<GetCustomModelRunPortionsResourceResponseContext> GetCustomModelRunPortionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the split portions that must be configured when defining a custom cross-validation strategy for model training.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

CleanMethodsResource

Declaration

Task<GetCleanMethodsResourceResponseContext> GetCleanMethodsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the list of available data cleaning methods for handling missing values.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

CrossValidationResetDefaultResource

Declaration

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

Remarks

Reset cross-validation configuration to default settings for a build info.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

DataSourceMissingValuesResource

Declaration

Task<GetDataSourceMissingValuesResourceResponseContext> GetDataSourceMissingValuesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int buildinfo_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve statistics about missing values in the buildinfo dataset including counts and percentages for each column.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

PredictionCallResource

Declaration

Task<GetPredictionCallResourceResponseContext> GetPredictionCallResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int prediction_call_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve details of a specific prediction call including scheduled and actual start/end times, prediction type (auto/manual), forecast date, forecast number, and custom forecast name.

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 identifier associated with the prediction call.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

PredictionCallResource

Declaration

Task<NullDataXperiflowResponseContext> PutPredictionCallResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int prediction_call_id, BodyPredictionCallContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Update the custom forecast name for a specific prediction call. Name must be less than 200 characters.

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 identifier associated with the prediction call.
Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.BodyPredictionCallContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

PredictionCallsResource

Declaration

Task<GetPredictionCallsResourceResponseContext> GetPredictionCallsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the history of prediction calls executed for a project along with the current forecast date that would be used if a new forecast were run immediately without updating source data.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve column metadata and statistics for all columns in the buildinfo dataset with pagination, filtering, and sorting support.

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.Int32[]	mutedStatusCodes
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?, int[], CancellationToken)

XperimentBuildModelRunSchemaResource

Declaration

Task<GetXperimentBuildModelRunSchemaResourceResponseContext> GetXperimentBuildModelRunSchemaResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int project_id, int xperimentbuild_id, string? model_stage = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the model run schema defining the pipeline stages and model execution plan for a specific experiment build and model stage.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve experiment kernels (trained models) for a specific experiment build with pagination, filtering, and sorting support.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the number of targets assigned to each event generator for a build info with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the number of targets assigned to each location for a build info with pagination support.

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.Int32[]	mutedStatusCodes
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?, int[], 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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve available checkpoints from the latest build info for project restoration. Checkpoints are valid for 7 days and include routine type, start time, and job ID. Returns empty if build info is offline or has no saved states.

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.Int32[]	mutedStatusCodes
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.