Interface IXperiflowWebAppClient

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

Assembly: Xperiflow.dll

Declaration

public interface IXperiflowWebAppClient

Methods

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

WebAppCollectionResource

Declaration

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

Remarks

Returns a collection of all web applications.

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.Threading.CancellationToken	cancellationToken	A cancellation token that can be 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?, CancellationToken)

StylesheetsResource

Declaration

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, CancellationToken cancellationToken = default)

Remarks

Returns a datatable of Stylesheets

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.Threading.CancellationToken	cancellationToken	A cancellation token that can be 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?, CancellationToken)

StylesheetsResource

Declaration

Task<PostStylesheetsResourceContext> PostStylesheetsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyListXpfStylesheetDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Creates a stylesheet and saves it 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.Threading.CancellationToken	cancellationToken	A cancellation token that can be 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?, CancellationToken)

StylesheetsResource

Declaration

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

Remarks

Deletes all stylesheets from the database and filesystem regardless of where or when they originated.

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.Threading.CancellationToken	cancellationToken	A cancellation token that can be 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?, CancellationToken)

StylesheetsBulkDeleteResource

Declaration

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

Remarks

Delete a list of Stylesheets from the database and filesystem.

Body params:

• item_ids (List[str]): The names of stylesheets to delete

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.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

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