Interface IXperiflowWebAppClient
Namespace: Workspace.XBR.Xperiflow.Core.RestApi.WebApp
Assembly: Xperiflow.dll
public interface IXperiflowWebAppClient
Methods
GetWebAppCollectionResourceAsync(XperiflowSessionInfo, string?, MemoizedCacheInfo?, int[], CancellationToken)
WebAppCollectionResource
Task<GetWebAppCollectionResourceResponseContext> GetWebAppCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Retrieve a collection of all available web applications with their metadata. Supports optional filtering via Pinq query expressions.
Returns
Task< Workspace.XBR.Xperiflow.Core.RestApi.WebApp.GetWebAppCollectionResourceResponseContext >
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.
GetStylesheetsResourceAsync(XperiflowSessionInfo, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, int[], CancellationToken)
StylesheetsResource
Task<GetStylesheetsResourceResponseContext> GetStylesheetsResourceAsync(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 stylesheets with pagination, filtering, and sorting support.
Returns
Task< Workspace.XBR.Xperiflow.Core.RestApi.WebApp.GetStylesheetsResourceResponseContext >
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.
PostStylesheetsResourceAsync(XperiflowSessionInfo, BodyListXpfStylesheetDto, MemoizedCacheInfo?, int[], CancellationToken)
StylesheetsResource
Task<PostStylesheetsResourceContext> PostStylesheetsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyListXpfStylesheetDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Create one or more stylesheets and save them to the database and filesystem.
Returns
Task< Workspace.XBR.Xperiflow.Core.RestApi.WebApp.PostStylesheetsResourceContext >
created
Parameters
| Type | Name | Description |
|---|---|---|
| Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo | x_OS_SessionInfo | OneStream session info header object. |
| Workspace.XBR.Xperiflow.Core.RestApi.WebApp.BodyListXpfStylesheetDto | 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.
DeleteStylesheetsResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, int[], CancellationToken)
StylesheetsResource
Task<NullDataXperiflowResponseContext> DeleteStylesheetsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Delete all stylesheets from the database and filesystem.
Returns
Task< Workspace.XBR.Xperiflow.Core.RestApi.WebApp.NullDataXperiflowResponseContext >
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.
PostStylesheetsBulkDeleteResourceAsync(XperiflowSessionInfo, Body, MemoizedCacheInfo?, int[], CancellationToken)
StylesheetsBulkDeleteResource
Task<NullDataXperiflowResponseContext> PostStylesheetsBulkDeleteResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, Body body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks
Delete multiple stylesheets by name from the database and filesystem.
Returns
Task< Workspace.XBR.Xperiflow.Core.RestApi.WebApp.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.WebApp.Body | 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.