Interface IXperiflowRoutinesClient
Namespace: Workspace.XBR.Xperiflow.Core.RestApi.Routines
Assembly: Xperiflow.dll
public interface IXperiflowRoutinesClient
Derived: Workspace.XBR.Xperiflow.Core.RestApi.Routines.XperiflowRoutinesClient, Workspace.XBR.Xperiflow.Core.RestApi.Routines.XperiflowRoutinesProjectsClient
Methods
GetRoutinesResourceAsync(XperiflowSessionInfo, bool?, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, int[], CancellationToken)
RoutinesResource
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve a list of available routines with optional filtering for latest versions only.
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.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.
GetRoutineConcurrentMemoryStatisticsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, int[], CancellationToken)
RoutineConcurrentMemoryStatisticsResource
Task<GetRoutineConcurrentMemoryStatisticsResourceContext> GetRoutineConcurrentMemoryStatisticsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve concurrent memory usage statistics for routine executions.
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.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.
GetTimeSeriesCleaningMethodOptionsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, int[], CancellationToken)
TimeSeriesCleaningMethodOptionsResource
Task<GetTimeSeriesCleaningMethodOptionsResourceContext> GetTimeSeriesCleaningMethodOptionsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve available cleaning method options for use in the TimeSeriesCleaningRoutine manifest table configuration.
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.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.
GetRoutineMemoryBoundsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, int[], CancellationToken)
RoutineMemoryBoundsResource
Task<GetRoutineMemoryBoundsResourceResponseContext> GetRoutineMemoryBoundsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve the minimum and maximum memory bounds for routine executions.
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.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.
GetRoutineTypesUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, int[], CancellationToken)
RoutineTypesUpdatedMemoryDefaultsResource
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve a paginated list of routine types and their configured memory default settings.
Returns
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.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.
PostRoutineTypesUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, RoutineUpdatedMemoryDefaultsRelationBodyContextDto, MemoizedCacheInfo?, int[], CancellationToken)
RoutineTypesUpdatedMemoryDefaultsResource
Task<NullDataXperiflowResponseContext> PostRoutineTypesUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, RoutineUpdatedMemoryDefaultsRelationBodyContextDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Create a new memory default configuration for a specific routine type.
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.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.
GetRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineTypeUpdatedMemoryDefaultsResource
Task<GetRoutineTypeUpdatedMemoryBlobContextDto> GetRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_type, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve the configured memory default settings for a specific 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.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.
PutRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, RoutineTypeUpdatedMemoryBlobContextDto, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineTypeUpdatedMemoryDefaultsResource
Task<NullDataXperiflowResponseContext> PutRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, RoutineTypeUpdatedMemoryBlobContextDto body, string routine_type, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Update the memory default settings for a specific 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.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.
DeleteRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineTypeUpdatedMemoryDefaultsResource
Task<NullDataXperiflowResponseContext> DeleteRoutineTypeUpdatedMemoryDefaultsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_type, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Delete custom memory default settings for a specific routine type, reverting to system defaults.
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.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.
GetRoutineRunMetadataInfosResourceAsync(XperiflowSessionInfo, IEnumerable<string>?, string?, int?, int?, string?, IEnumerable<string>?, IEnumerable<string>?, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunMetadataInfosResource
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve a paginated list of routine instance runs with detailed metadata information.
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.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.
PostRoutineRunMetadataInfosResourceAsync(XperiflowSessionInfo, RoutineCreateRunPostContextDto, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunMetadataInfosResource
Task<PostRoutineRunMetadataInfosResourceResponseContext> PostRoutineRunMetadataInfosResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, RoutineCreateRunPostContextDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Create a new routine instance run, with optional automatic execution start.
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.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.
GetGlobalRoutineDocumentationResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, int[], CancellationToken)
GlobalRoutineDocumentationResource
Task<GetGlobalRoutineDocumentationResourceResponseContext> GetGlobalRoutineDocumentationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve comprehensive HTML documentation for all available 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.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.
GetRoutineDocumentationResourceAsync(XperiflowSessionInfo, string, string?, MemoizedCacheInfo?, int[], CancellationToken)
RoutineDocumentationResource
Task<GetRoutineDocumentationResourceResponseContext> GetRoutineDocumentationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_name, string? version = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve HTML documentation for a specific routine by name and version.
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.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.
GetRoutineInstanceArtifactPreviewMetadataInfoResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstanceArtifactPreviewMetadataInfoResource
Task<GetRoutineInstanceArtifactPreviewMetadataInfoResource> GetRoutineInstanceArtifactPreviewMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string path, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve a preview of artifact metadata information for quick inspection without full download.
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.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.
GetRoutineInstanceArtifactsStatisticsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstanceArtifactsStatisticsResource
Task<GetRoutineInstanceArtifactsStatisticsResourceResponseContext> GetRoutineInstanceArtifactsStatisticsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string path, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve statistical summary information for a specific artifact generated by a routine instance.
Returns
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.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.
GetRoutineInstanceArtifactsMetadataResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstanceArtifactsMetadataResource
Task<GetRoutineInstanceArtifactsMetadataResourceResponseContext> GetRoutineInstanceArtifactsMetadataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string path, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve metadata for a specific artifact generated by a routine instance.
Returns
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.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.
GetRoutineInstancesResourceAsync(XperiflowSessionInfo, IEnumerable<string>?, string?, int?, int?, string?, IEnumerable<string>?, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstancesResource
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve a paginated list of routine instances with optional filtering and sorting.
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.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.
PostRoutineInstancesResourceAsync(XperiflowSessionInfo, PostBodyRoutineInstancesDto, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstancesResource
Task<PostRoutineInstancesResourceContext> PostRoutineInstancesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, PostBodyRoutineInstancesDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Create a new routine instance with specified parameters and configuration.
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.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.
GetRoutineInstanceArtifactsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstanceArtifactsResource
Task<GetRoutineInstanceArtifactsResourceResponseContext> GetRoutineInstanceArtifactsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve all artifacts generated across all runs of a specific 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.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.
GetRoutineRunArtifactsResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunArtifactsResource
Task<GetRoutineRunArtifactsResourceResponseContext> GetRoutineRunArtifactsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve all artifacts generated by a specific 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.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.
PostRoutineRunStartResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunStartResource
Task<NullableIntItemIdentifierXperiflowResponseContext> PostRoutineRunStartResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Initiate execution of a routine instance run.
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.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.
PostRoutineRunStartInMemoryResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunStartInMemoryResource
Task<ResponseRoutineRunStartInMemoryContext> PostRoutineRunStartInMemoryResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Initiate execution of a routine instance run in memory, bypassing database persistence.
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.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.
GetRoutineExecutionMetadataResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineExecutionMetadataResource
Task<GetResponseRoutineRunExecutionMetadataContext> GetRoutineExecutionMetadataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve execution-specific metadata for a routine run, including status and timing information.
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.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.
GetRoutineRunMetadataResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunMetadataResource
Task<GetResponseRoutineRunMetadataContext> GetRoutineRunMetadataResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve metadata for a specific routine run, including parameters and configuration.
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.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.
GetRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunMetadataInfoResource
Task<GetResponseRoutineRunMetadataInfoContext> GetRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve detailed metadata information for a specific routine instance run.
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.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.
PutRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo, string, string, RoutineRunMetadataInfoPutDto, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunMetadataInfoResource
Task<NullDataXperiflowResponseContext> PutRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, RoutineRunMetadataInfoPutDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Update the name and description metadata for a specific routine instance 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.RoutineRunMetadataInfoPutDto | 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.
DeleteRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunMetadataInfoResource
Task<NullDataXperiflowResponseContext> DeleteRoutineRunMetadataInfoResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Delete a specific routine instance run and all its associated artifacts from 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.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.
GetRoutineInstanceResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstanceResource
Task<GetRoutineInstanceResourceResponseContext> GetRoutineInstanceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve detailed information about a specific routine instance by its ID.
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.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.
PutRoutineInstanceResourceAsync(XperiflowSessionInfo, string, BodyRoutineInstanceDto, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstanceResource
Task<NullDataXperiflowResponseContext> PutRoutineInstanceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, BodyRoutineInstanceDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Update metadata and configuration for a specific routine instance.
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.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.
DeleteRoutineInstanceResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineInstanceResource
Task<NullDataXperiflowResponseContext> DeleteRoutineInstanceResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Delete a routine instance and all its associated runs and artifacts from 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.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.
PostRoutineRunCancelResourceAsync(XperiflowSessionInfo, string, string, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunCancelResource
Task<NullDataXperiflowResponseContext> PostRoutineRunCancelResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Cancel a routine run execution, stopping it if currently running or removing it from the queue if pending.
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.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.
PutRoutineRunParameterValidationResourceAsync(XperiflowSessionInfo, string, string, RoutineRunParameterValidationPutDto, MemoizedCacheInfo?, int[], CancellationToken)
RoutineRunParameterValidationResource
Task<NullDataXperiflowResponseContext> PutRoutineRunParameterValidationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_instance_id, string routine_run_id, RoutineRunParameterValidationPutDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Validate input parameters against the schema for a specific 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.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.
GetRoutineLabelsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, int[], CancellationToken)
RoutineLabelsResource
Task<GetRoutineLabelsResourceResponseContext> GetRoutineLabelsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve all labels associated with routine instances and runs for filtering and organization.
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.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.
GetRoutineResourceAsync(XperiflowSessionInfo, string, IEnumerable<string>?, MemoizedCacheInfo?, int[], CancellationToken)
RoutineResource
Task<GetRoutineResourceResponseContext> GetRoutineResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string routine_name, IEnumerable<string>? methods_to_include = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve metadata and configuration details for a specific routine by name.
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.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.