Interface IXperiflowGeneratorsClient

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

Assembly: Xperiflow.dll

Declaration

public interface IXperiflowGeneratorsClient

Methods

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

GeneratorPackagesResource

Declaration

Task<GetGeneratorPackagesResourceResponseContext> GetGeneratorPackagesResourceAsync(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

Resource to retrieve a datatable context of available eventpackages.

Possible status codes: 200

Returns:

• query_status (QueryStatusContext): If query was successful

• packages (DataTableContext): Datatable containing columns ID, NameLower, Name, and Description

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.GetGeneratorPackagesResourceResponseContext >

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.

PostGeneratorPackagesResourceAsync(XperiflowSessionInfo, BodyGeneratorPackagesContext, MemoizedCacheInfo?, CancellationToken)

GeneratorPackagesResource

Declaration

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

Remarks

Create an event package.

Possible status codes: 200, 201

Body Params:

• name (str): The name of the event package

• desciption (str): The description of the event package

Returns:

• name (str): The name of the posted eventpackage

• modified (bool): If the post was successful

• message (str): Message regarding post of event package

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.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.Generators.BodyGeneratorPackagesContext	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.

GetGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

GeneratorPackageGeneratorsResource

Declaration

Task<GetGeneratorPackageGeneratorsResourceResponseContext> GetGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string package_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Resource to get generators for the generator package

Returns:

• data (DataTableContext): The generators corresponding to the event package.

  Columns include ID, GeneratorName, InitParameters, FitParameters, AutoGenerated, BypassFeatureSelection

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.GetGeneratorPackageGeneratorsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	package_name
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.

PutGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo, IntItemsIdentifierContext, string, MemoizedCacheInfo?, CancellationToken)

GeneratorPackageGeneratorsResource

Declaration

Task<NullDataXperiflowResponseContext> PutGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, IntItemsIdentifierContext body, string package_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Resource to update the generators of a generator package. A list of nothing will delete all generators. A list of one event will reassign that package to have one event, and so on.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.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.Generators.IntItemsIdentifierContext	body
System.String	package_name
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.

PutGeneratorPackageResourceAsync(XperiflowSessionInfo, PutBodyGeneratorPackageContext, string, MemoizedCacheInfo?, CancellationToken)

GeneratorPackageResource

Declaration

Task<NullDataXperiflowResponseContext> PutGeneratorPackageResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, PutBodyGeneratorPackageContext body, string package_name, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Resource to update the description of an event package.

Body Params:

• description (str): The new description of the event package

Returns:

• name (str): The name of the event package that was updated

• modified (bool): If the Generator package was updated

• message (str): A message corresponding to the success of the update

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.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.Generators.PutBodyGeneratorPackageContext	body
System.String	package_name
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.

DeleteGeneratorPackageResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, CancellationToken)

GeneratorPackageResource

Declaration

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

Remarks

Resource to get a Generator package.

Returns:

• name (str): The name of the event package that was deleted

• modified (bool): If the event package was deleted

• message (str): A message corresponding to the success of the delete

Returns

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

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	package_name
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.

PostGeneratorPBMResourceAsync(XperiflowSessionInfo, BodyGeneratorPbmDto, MemoizedCacheInfo?, CancellationToken)

GeneratorPBMResource

Declaration

Task<PostResponseGeneratorPbmResource> PostGeneratorPBMResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyGeneratorPbmDto body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Create a new generator workflow

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.PostResponseGeneratorPbmResource >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Generators.BodyGeneratorPbmDto	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.

PostOccurrencesExpansionResourceAsync(XperiflowSessionInfo, PostBodyOccurrencesExpansionContext, MemoizedCacheInfo?, CancellationToken)

OccurrencesExpansionResource

Declaration

Task<PostResponseOccurrencesExpansionContext> PostOccurrencesExpansionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, PostBodyOccurrencesExpansionContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of dates that correspond to the given occurrences

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.PostResponseOccurrencesExpansionContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Generators.PostBodyOccurrencesExpansionContext	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.

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

GeneratorCollectionResource

Declaration

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

Remarks

Returns a collection of all generators.

Query Parameters

• query (Optional/[str/]): Pinq query filter expression

Returns

• collection (List/[Dict/[str, Any/]/]): Each dictionary will be a generator including the name, parent class, and all class attributes of the generator.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.GetGeneratorCollectionResourceResponseContext >

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.