Class XperiflowConduitClient

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

Assembly: Xperiflow.dll

Declaration

public class XperiflowConduitClient : IXperiflowConduitClient

Implements: Workspace.XBR.Xperiflow.Core.RestApi.Conduit.IXperiflowConduitClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Methods

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

TaskCollectionResource

Declaration

public virtual Task<GetTaskCollectionResourceResponseContext> GetTaskCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of all Xperiflow Tasks

Query Parameters

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

Returns

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

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetTaskCollectionResourceResponseContext >

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.

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

JobCollectionResource

Declaration

public virtual Task<GetJobCollectionResourceResponseContext> GetJobCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Returns a list of all Xperiflow Tasks

Query Parameters

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

Returns

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

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetJobCollectionResourceResponseContext >

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.

GetActivityStatusesResourceAsync(XperiflowSessionInfo, MemoizedCacheInfo?, CancellationToken)

ActivityStatusesResource

Declaration

public virtual Task<GetActivityStatusesResourceResponseContext> GetActivityStatusesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieve the viable ActivityStatusOptions that can be used to query the JobList API.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetActivityStatusesResourceResponseContext >

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.

PostBackgroundJobCreationResourceAsync(XperiflowSessionInfo, BodyBackgroundJobCreationContext, MemoizedCacheInfo?, CancellationToken)

BackgroundJobCreationResource

Declaration

public virtual Task<PostBackgroundJobCreationResourceResponseContext> PostBackgroundJobCreationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyBackgroundJobCreationContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Submit a XperiFlow Python Job to be processed by the Conduit Orchestration Framework as a background job. Background jobs will be executed immediately and do not occupy an orchestrator

Supported Activity Types:

• Target Data Validation

  • activity_type: ScenarioExcelCreation

  • app: sml

  • comm_metadata_json:

    • task_storage

      • scenario_id: int

      • fill_with_forecasted_data: bool

      • hashkeys: Optional[set[str]] = None

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.PostBackgroundJobCreationResourceResponseContext >

created

Parameters

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

GetBackgroundJobResultResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

BackgroundJobResultResource

Declaration

public virtual Task<GetBackgroundJobResultResourceResponseContext> GetBackgroundJobResultResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets the result of the BackgroundJob.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetBackgroundJobResultResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	job_id	the unique identifier associated with the job.
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.

PostJobCancellationResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

JobCancellationResource

Declaration

public virtual Task<NullableIntItemIdentifierXperiflowResponseContext> PostJobCancellationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Cancells the given job 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.Conduit.NullableIntItemIdentifierXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	job_id	the unique identifier associated with the job.
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.

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

JobsResource

Declaration

public virtual Task<GetJobsResourceResponseContext> GetJobsResourceAsync(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

Retrieves the Job Activity Table. Optionally can provide Job ActivityStatus to filter. All records come ordered by QueuedTime

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetJobsResourceResponseContext >

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.

PostJobsResourceAsync(XperiflowSessionInfo, BodyJobsContext, MemoizedCacheInfo?, CancellationToken)

JobsResource

Declaration

public virtual Task<NullableIntItemIdentifierXperiflowResponseContext> PostJobsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyJobsContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Submit a XperiFlow Python Job to be processed by the Conduit Orchestration Framework.

Returns

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

ok

Parameters

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

GetJobResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

JobResource

Declaration

public virtual Task<GetJobResourceResponseContext> GetJobResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Gets the status and details of an XperiFlow Python Job being managed by the Conduit Orchestration Framework.

Returns:

• query_status (Dict)

  • If query was successful.

• job_id (int)

  • The Job ID retrieved

• activity_type (str)

  • The activity type of the job

• activity_source (str)

  • Where the job came from

• activity_status (str)

  • The status of the job

• is_scheduled (bool)

  • Whether or not this job was scheduled to occur in advance.

• creation_time (str)

  • The time that the job was created

• queued_time (str{datetime})

  • The time the job is queued. This time ultimately determines when the job is allowed to be run. The current time is earlier than this

time, then the Job will not be considered to be run while the job is in a activity_status='queued' - start_time (str{datetime})

• The time the job was started

• end_time (str{datetime})

  • The time the job ended

• last_activity_time (str{datetime})

  • The last time the job was active

• percent_complete (float)

  • The percent complete of the job

• total_tasks (int)

  • The total number of tasks the job spawned

• completed_tasks (int)

  • The total number of tasks spawned from the job that are completed

• server_name (str)

  • The server that picked up the job

• app_name (str)

  • The app the job came from

• project_id (str{guid})

  • The project id corresponding to the job

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetJobResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	job_id	the unique identifier associated with the job.
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.

PutJobResourceAsync(XperiflowSessionInfo, BodyJobContext, int, MemoizedCacheInfo?, CancellationToken)

JobResource

Declaration

public virtual Task<NullDataXperiflowResponseContext> PutJobResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyJobContext body, int job_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Updates a Job's QueuedTime in the Job Activity Table. This API is very selective about what type of jobs can be updated. Specifically, Jobs that can be updated must be in the following state:

is_scheduled = True & & activity status = 'queued'

Body Parameters:

• schedule_time: datetime - The time to schedule the job for. This will update the queued time. The schedule time will not be set if the provided time is less than the current time (UTC). - job_id: int - The type of Job to run - project_id: Optional[str (guid)] - The project unique identifier that is associated with the Job to delete. If not provided, then there will be no restriction on the job being updated. If this is provided, it is expected that the project id associated with the job_id in the XperiFlow engine matches the job_id and project_id provided here. It is best practice to always include this project_id for jobs that are tied to a specific project.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.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.Conduit.BodyJobContext	body
System.Int32	job_id	the unique identifier associated with the job.
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.

DeleteJobResourceAsync(XperiflowSessionInfo, int, MemoizedCacheInfo?, CancellationToken)

JobResource

Declaration

public virtual Task<NullDataXperiflowResponseContext> DeleteJobResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Delete a Job from the Job Activity Table. This API is very selective about what type of jobs can be deleted. Specifically, Jobs that can be deleted must be in the following state: is_scheduled = True & & activity status = queued

Returns

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

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	job_id	the unique identifier associated with the job.
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.

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

TaskTreeResource

Declaration

public virtual Task<GetTaskTreeResourceResponseContext> GetTaskTreeResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, IEnumerable<string>? task_types = null, bool? include_depth = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves records of Python Tasks related to a particular Job within the Conduit Orchestration Framework.

Tasks live underneath a Job carry status about how far along the task itself is, as well as overall effect on the Job.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetTaskTreeResourceResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	job_id	the unique identifier associated with the job.
System.Collections.Generic.IEnumerable<System.String>	task_types	A routine type must be one of the valid task routines found in XperiFlow.
System.Nullable<System.Boolean>	include_depth	Whether or not to get the task status information for all other sub tasks recursively. If the requested routine_type has children subtasks, it will embed the children in its sub_task attribute
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.

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

TaskHandlersResource

Declaration

public virtual Task<GetTaskHandlersResourceResponseContext> GetTaskHandlersResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, string? task_type = null, string? execution_type = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Get api to retrieve python script text for a given routine type, or a given routine type and execution type. The execution type must be one of:

• before

• after

• final

• failure

• retry

Returns:

• query_status (Dict)

• If query was successful.

• eventhandlers_dict (Dict)

• FeatureName

• FeatureValue

• PredictionAvgValue

• TargetAvgValue

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetTaskHandlersResourceResponseContext >

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.String	task_type
System.String	execution_type
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.

PutTaskHandlersResourceAsync(XperiflowSessionInfo, BodyTaskHandlersContext, MemoizedCacheInfo?, CancellationToken)

TaskHandlersResource

Declaration

public virtual Task<NullDataXperiflowResponseContext> PutTaskHandlersResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyTaskHandlersContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Put api to input or update the python script text for a given routine type and execution type. The execution type must be one of:

• before

• after

• final

• failure

• retry

Returns:

• modified (bool)

• message (str)

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.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.Conduit.BodyTaskHandlersContext	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.

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

TaskHandlersResource

Declaration

public virtual Task<NullDataXperiflowResponseContext> DeleteTaskHandlersResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, string? task_type = null, string? execution_type = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

This deletes a routine from the database by either using a routine type, or an execution type and routine type. Both are expected to be a str

Returns

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

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.String	task_type
System.String	execution_type
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.

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

TasksResource

Declaration

public virtual Task<GetTasksResourceResponseContext> GetTasksResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, string? activity_status = null, string? search_filter = null, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Retrieves the Task Activity Table By a JobID. Optionally can provide Task ActivityStatus to filter. All records come ordered by QueuedTime.

Note:

• Querying using activity_status set to None and activity_status = "all" will yield the same result.

ActivityStatus Options:

• running

• running_subtasks

• queued

• worker_queued

• completed

• usercancelled

• syscancelled

• syserror

• initialized

• all

ActivityStatus Options:

• running

• running_subtasks

• queued

• worker_queued

• completed

• usercancelled

• syscancelled

• syserror

• initialized

• all

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Conduit.GetTasksResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Int32	job_id	the unique identifier associated with the job.
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.String	activity_status
System.String	search_filter
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.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<XperiflowConduitClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Returns

Task<Workspace.XBR.Xperiflow.Core.RestApi.Conduit.XperiflowConduitClient.ObjectResponseResult{{T}}>

Parameters

Type	Name
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<System.String,System.Collections.Generic.IEnumerable{System.String}>	headers
System.Threading.CancellationToken	cancellationToken

Type Parameters

• T

Implements

• Workspace.XBR.Xperiflow.Core.RestApi.Conduit.IXperiflowConduitClient

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString