Interface IXperiflowRoutinesClient

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

Assembly: Xperiflow.dll

Declaration

public interface IXperiflowRoutinesClient

Methods

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

RoutinesResource

Declaration

Task<GetRoutinesResourceResponseContext> GetRoutinesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, bool? only_latest_version = null, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of Routines

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutinesResourceResponseContext >

ok

Parameters

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

Exceptions

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

GetRoutineConcurrentMemoryStatisticsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

RoutineConcurrentMemoryStatisticsResource

Declaration

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

Remarks

Returns concurrent memory statistics for routines

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineConcurrentMemoryStatisticsResourceContext >

ok

Parameters

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

Exceptions

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

GetTimeSeriesCleaningMethodOptionsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

TimeSeriesCleaningMethodOptionsResource

Declaration

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

Remarks

Returns a list of acceptable options for the CleaningMethod column of cleaning manifest table in the TimeSeriesCleaningRoutine

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetTimeSeriesCleaningMethodOptionsResourceContext >

ok

Parameters

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

Exceptions

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

GetRoutineMemoryBoundsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

RoutineMemoryBoundsResource

Declaration

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

Remarks

Returns memory bounds

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineMemoryBoundsResourceResponseContext >

ok

Parameters

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

Exceptions

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

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

RoutineTypesUpdatedMemoryDefaultsResource

Declaration

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

Remarks

Returns a datatable of Routine Types updated defaults relation

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineTypesUpdatedMemoryDefaultsResourceResponseContext >

ok

Parameters

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

Exceptions

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

PostRoutineTypesUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, RoutineUpdatedMemoryDefaultsRelationBodyContextDto, MemoizedCacheInfo?, CancellationToken)

RoutineTypesUpdatedMemoryDefaultsResource

Declaration

Task<NullDataXperiflowResponseContext> PostRoutineTypesUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, RoutineUpdatedMemoryDefaultsRelationBodyContextDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Creates a routine type updated default relation in the table.

Returns

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

created

Parameters

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

Exceptions

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

GetRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineTypeUpdatedMemoryDefaultsResource

Declaration

Task<GetRoutineTypeUpdatedMemoryBlobContextDto> GetRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_type, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves an updated memory default for a routine type

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineTypeUpdatedMemoryBlobContextDto >

ok

Parameters

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

Exceptions

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

PutRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, RoutineTypeUpdatedMemoryBlobContextDto, string, MemoizedCacheInfo?, CancellationToken)

RoutineTypeUpdatedMemoryDefaultsResource

Declaration

Task<NullDataXperiflowResponseContext> PutRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, RoutineTypeUpdatedMemoryBlobContextDto body, string routine_type, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update method memory defaults for a specified routine type.

Returns

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

ok

Parameters

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

Exceptions

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

DeleteRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineTypeUpdatedMemoryDefaultsResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_type, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a routine instance in the database.

Returns

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

ok

Parameters

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

Exceptions

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

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

RoutineRunMetadataInfosResource

Declaration

Task<GetRoutineRunMetadataInfosResourceResponseContext> GetRoutineRunMetadataInfosResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, IEnumerable<string>? routine_instance_labels = null, IEnumerable<string>? routine_run_labels = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a datatable of Routine Instance Runs

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineRunMetadataInfosResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
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.Collections.Generic.IEnumerable<System.String>	routine_instance_labels	A list of routine instance label names to filter in the request.
System.Collections.Generic.IEnumerable<System.String>	routine_run_labels	A list of routine run label names to filter in the request.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

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

PostRoutineRunMetadataInfosResourceAsync(XperiflowSessionInfo, RoutineCreateRunPostContextDto, MemoizedCacheInfo?, CancellationToken)

RoutineRunMetadataInfosResource

Declaration

Task<PostRoutineRunMetadataInfosResourceResponseContext> PostRoutineRunMetadataInfosResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, RoutineCreateRunPostContextDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Creates a routine instance run in the table. Optionally starts the run.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.PostRoutineRunMetadataInfosResourceResponseContext >

created

Parameters

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

Exceptions

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

GetGlobalRoutineDocumentationResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

GlobalRoutineDocumentationResource

Declaration

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

Remarks

Returns an HTML file containing the documentation for all routines

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetGlobalRoutineDocumentationResourceResponseContext >

ok

Parameters

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

Exceptions

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

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

RoutineDocumentationResource

Declaration

Task<GetRoutineDocumentationResourceResponseContext> GetRoutineDocumentationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_name, string? version = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns an HTML file containing the documentation for the specified routine

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineDocumentationResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	routine_name	the name of the routine or routines.
System.String	version	The version number associated with the routine.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

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

GetRoutineInstanceArtifactPreviewMetadataInfoResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineInstanceArtifactPreviewMetadataInfoResource

Declaration

Task<GetRoutineInstanceArtifactPreviewMetadataInfoResource> GetRoutineInstanceArtifactPreviewMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string path, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

API dedicated to retrieving Artifact Metadata info previews

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineInstanceArtifactPreviewMetadataInfoResource >

ok

Parameters

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

Exceptions

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

GetRoutineInstanceArtifactsStatisticsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineInstanceArtifactsStatisticsResource

Declaration

Task<GetRoutineInstanceArtifactsStatisticsResourceResponseContext> GetRoutineInstanceArtifactsStatisticsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string path, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets the statistics for a given artifact of a routine instance.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineInstanceArtifactsStatisticsResourceResponseContext >

ok

Parameters

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

Exceptions

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

GetRoutineInstanceArtifactsMetadataResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineInstanceArtifactsMetadataResource

Declaration

Task<GetRoutineInstanceArtifactsMetadataResourceResponseContext> GetRoutineInstanceArtifactsMetadataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string path, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets the metadata for a given artifact for a given routine instance.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineInstanceArtifactsMetadataResourceResponseContext >

ok

Parameters

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

Exceptions

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

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

RoutineInstancesResource

Declaration

Task<GetRoutineInstancesResourceResponseContext> GetRoutineInstancesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, IEnumerable<string>? routine_instance_labels = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a datatable of Routine Instances

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineInstancesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
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.Collections.Generic.IEnumerable<System.String>	routine_instance_labels	A list of routine instance label names to filter in the request.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

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

PostRoutineInstancesResourceAsync(XperiflowSessionInfo, PostBodyRoutineInstancesDto, MemoizedCacheInfo?, CancellationToken)

RoutineInstancesResource

Declaration

Task<PostRoutineInstancesResourceContext> PostRoutineInstancesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, PostBodyRoutineInstancesDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Creates a routine instance in the table.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.PostRoutineInstancesResourceContext >

created

Parameters

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

Exceptions

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

GetRoutineInstanceArtifactsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineInstanceArtifactsResource

Declaration

Task<GetRoutineInstanceArtifactsResourceResponseContext> GetRoutineInstanceArtifactsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets the artifacts for all runs for a given routine instance.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineInstanceArtifactsResourceResponseContext >

ok

Parameters

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

Exceptions

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

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

RoutineRunArtifactsResource

Declaration

Task<GetRoutineRunArtifactsResourceResponseContext> GetRoutineRunArtifactsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves artifacts for a routine instance run.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineRunArtifactsResourceResponseContext >

ok

Parameters

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

Exceptions

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

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

RoutineRunStartResource

Declaration

Task<NullableIntItemIdentifierXperiflowResponseContext> PostRoutineRunStartResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Starts a routine instance run in the table.

Returns

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

ok

Parameters

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

Exceptions

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

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

RoutineRunStartInMemoryResource

Declaration

Task<ResponseRoutineRunStartInMemoryContext> PostRoutineRunStartInMemoryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Starts a routine instance run in memory execution style.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.ResponseRoutineRunStartInMemoryContext >

ok

Parameters

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

Exceptions

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

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

RoutineExecutionMetadataResource

Declaration

Task<GetResponseRoutineRunExecutionMetadataContext> GetRoutineExecutionMetadataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves a routine run execution metadata from the table.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetResponseRoutineRunExecutionMetadataContext >

ok

Parameters

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

Exceptions

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

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

RoutineRunMetadataResource

Declaration

Task<GetResponseRoutineRunMetadataContext> GetRoutineRunMetadataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves a routine run metadata from the table.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetResponseRoutineRunMetadataContext >

ok

Parameters

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

Exceptions

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

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

RoutineRunMetadataInfoResource

Declaration

Task<GetResponseRoutineRunMetadataInfoContext> GetRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves a routine instance run metadata info from the table.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetResponseRoutineRunMetadataInfoContext >

ok

Parameters

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

Exceptions

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

PutRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo, string, string, RoutineRunMetadataInfoPutDto, MemoizedCacheInfo?, CancellationToken)

RoutineRunMetadataInfoResource

Declaration

Task<NullDataXperiflowResponseContext> PutRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, RoutineRunMetadataInfoPutDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update a routine instance run's name and description

Returns

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

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	routine_instance_id	The unique identifier associated with the routine instance.
System.String	routine_run_id	the unique identifier associated with the routine run.
Workspace.XBR.Xperiflow.Core.RestApi.Routines.RoutineRunMetadataInfoPutDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

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

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

RoutineRunMetadataInfoResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a routine instance run in the database.

Returns

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

ok

Parameters

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

Exceptions

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

GetRoutineInstanceResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineInstanceResource

Declaration

Task<GetRoutineInstanceResourceResponseContext> GetRoutineInstanceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves a routine instance in the table.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineInstanceResourceResponseContext >

ok

Parameters

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

Exceptions

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

PutRoutineInstanceResourceAsync(XperiflowSessionInfo, string, BodyRoutineInstanceDto, MemoizedCacheInfo?, CancellationToken)

RoutineInstanceResource

Declaration

Task<NullDataXperiflowResponseContext> PutRoutineInstanceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, BodyRoutineInstanceDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Update a routine instance in the database.

Returns

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

ok

Parameters

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

Exceptions

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

DeleteRoutineInstanceResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

RoutineInstanceResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteRoutineInstanceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a routine instance in the database.

Returns

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

ok

Parameters

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

Exceptions

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

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

RoutineRunCancelResource

Declaration

Task<NullDataXperiflowResponseContext> PostRoutineRunCancelResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Cancells the given routine run ID. If the job is queued it will be marked as "usercancelled" if it is running, it will be marked as "pending_usercancelled". If it is already in a stopping state it will not be re-cancelled and modified result will be false.

Returns

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

ok

Parameters

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

Exceptions

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

PutRoutineRunParameterValidationResourceAsync(XperiflowSessionInfo, string, string, RoutineRunParameterValidationPutDto, MemoizedCacheInfo?, CancellationToken)

RoutineRunParameterValidationResource

Declaration

Task<NullDataXperiflowResponseContext> PutRoutineRunParameterValidationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, RoutineRunParameterValidationPutDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Validates parameters for a routine run.

Returns

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

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	routine_instance_id	The unique identifier associated with the routine instance.
System.String	routine_run_id	the unique identifier associated with the routine run.
Workspace.XBR.Xperiflow.Core.RestApi.Routines.RoutineRunParameterValidationPutDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

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

GetRoutineLabelsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

RoutineLabelsResource

Declaration

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

Remarks

Retrieves all the routine instance and runs labels that exist.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineLabelsResourceResponseContext >

ok

Parameters

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

Exceptions

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

GetRoutineResourceAsync(XperiflowSessionInfo, string, IEnumerable<string>?, MemoizedCacheInfo?, CancellationToken)

RoutineResource

Declaration

Task<GetRoutineResourceResponseContext> GetRoutineResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_name, IEnumerable<string>? methods_to_include = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a Routine

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Routines.GetRoutineResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	routine_name	the name of the routine or routines.
System.Collections.Generic.IEnumerable<System.String>	methods_to_include	A json list of method names to include.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

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