Skip to main content

Interface IXperiflowConduitClient

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

Assembly: Xperiflow.dll

Declaration
public interface IXperiflowConduitClient

Methods

GetTaskCollectionResourceAsync(XperiflowSessionInfo, string?, MemoizedCacheInfo?, int[], CancellationToken)

TaskCollectionResource

Declaration
Task<GetTaskCollectionResourceResponseContext> GetTaskCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve a collection of all available Xperiflow task types with their metadata including name, parent class, and attributes. Supports optional filtering via Pinq query expressions.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.StringqueryA pinq query string.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

JobCollectionResource

Declaration
Task<GetJobCollectionResourceResponseContext> GetJobCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve metadata for all available Xperiflow job types including their names, parent classes, class attributes, and communication metadata schemas. Supports filtering via Pinq query expressions to find specific job implementations.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.StringqueryA pinq query string.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

ActivityStatusesResource

Declaration
Task<GetActivityStatusesResourceResponseContext> GetActivityStatusesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve available activity status options that can be used for filtering jobs and tasks in API queries.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

BackgroundJobCreationResource

Declaration
Task<PostBackgroundJobCreationResourceResponseContext> PostBackgroundJobCreationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyBackgroundJobCreationContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Submit an Xperiflow Python job as a background job for immediate execution without occupying an orchestrator. Supports various activity types including scenario excel creation and data validation tasks.

Returns

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

created

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Conduit.BodyBackgroundJobCreationContextbody
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

BackgroundJobResultResource

Declaration
Task<GetBackgroundJobResultResourceResponseContext> GetBackgroundJobResultResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve the execution result and output data from a completed background job.

Returns

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

created

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Int32job_idThe unique identifier associated with the job.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

JobCancellationResource

Declaration
Task<NullableIntItemIdentifierXperiflowResponseContext> PostJobCancellationResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Cancel a job by marking it as user-cancelled (if queued) or pending cancellation (if running). Jobs already in a stopping state will not be re-cancelled.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Int32job_idThe unique identifier associated with the job.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

JobsResource

Declaration
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve the job activity table with optional filtering by activity status. Results are ordered by queued time with pagination support.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Collections.Generic.IEnumerable<System.String>fieldsA json list of column names to return in the request.
System.StringfilterA json dictionary of a filter statement.
System.Nullable<System.Int32>pageThe page to return if using pagination.
System.Nullable<System.Int32>records_per_pageThe amount of records per page to return if using pagination.
System.Stringorder_bysA json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

JobsResource

Declaration
Task<NullableIntItemIdentifierXperiflowResponseContext> PostJobsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyJobsContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Submit an Xperiflow Python job to be processed by the Conduit orchestration framework. Returns the created job ID.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Conduit.BodyJobsContextbody
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

JobResource

Declaration
Task<GetJobResourceResponseContext> GetJobResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve detailed status and metadata for a specific job including activity type, status, timing information, progress percentage, task counts, and configuration parameters.

Returns

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

created

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Int32job_idThe unique identifier associated with the job.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

JobResource

Declaration
Task<NullDataXperiflowResponseContext> PutJobResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyJobContext body, int job_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Update a scheduled job's queued time. Only jobs that are scheduled and in queued status can be updated. The schedule time cannot be set to a past time.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Conduit.BodyJobContextbody
System.Int32job_idThe unique identifier associated with the job.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

JobResource

Declaration
Task<NullDataXperiflowResponseContext> DeleteJobResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Delete a scheduled job from the activity table. Only jobs that are scheduled and in queued status can be deleted.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Int32job_idThe unique identifier associated with the job.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

TaskTreeResource

Declaration
Task<GetTaskTreeResourceResponseContext> GetTaskTreeResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, int job_id, IEnumerable<string>? task_types = null, bool? include_depth = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve hierarchical task tree for a job showing task status and relationships. Supports filtering by task types and optional recursive inclusion of subtask details.

Returns

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

created

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Int32job_idThe unique identifier associated with the job.
System.Collections.Generic.IEnumerable<System.String>task_typesA routine type must be one of the valid task routines found in Xperiflow.
System.Nullable<System.Boolean>include_depthWhether 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.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

TaskHandlersResource

Declaration
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve Python event handler scripts for task lifecycle hooks including before, after, final, failure, and retry execution types for a specific task type with pagination and filtering support.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Collections.Generic.IEnumerable<System.String>fieldsA json list of column names to return in the request.
System.StringfilterA json dictionary of a filter statement.
System.Nullable<System.Int32>pageThe page to return if using pagination.
System.Nullable<System.Int32>records_per_pageThe amount of records per page to return if using pagination.
System.Stringorder_bysA json dictionary containing an order by statement.
System.Stringtask_type
System.Stringexecution_type
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

TaskHandlersResource

Declaration
Task<NullDataXperiflowResponseContext> PutTaskHandlersResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyTaskHandlersContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Create or update a Python event handler script for a task lifecycle hook, specifying the task type and execution type (before, after, final, failure, or retry).

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Conduit.BodyTaskHandlersContextbody
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

TaskHandlersResource

Declaration
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Delete a Python event handler script for a task by specifying the task type and optionally the execution type to remove specific lifecycle hooks.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Collections.Generic.IEnumerable<System.String>fieldsA json list of column names to return in the request.
System.StringfilterA json dictionary of a filter statement.
System.Nullable<System.Int32>pageThe page to return if using pagination.
System.Nullable<System.Int32>records_per_pageThe amount of records per page to return if using pagination.
System.Stringorder_bysA json dictionary containing an order by statement.
System.Stringtask_type
System.Stringexecution_type
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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?, int[], CancellationToken)

TasksResource

Declaration
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, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)
Remarks

Retrieve tasks for a specific job with optional filtering by activity status (running, queued, completed, cancelled, error, etc.). Results are ordered by queued time with pagination support.

Returns

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

ok

Parameters
TypeNameDescription
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfox_OS_SessionInfoOneStream session info header object.
System.Int32job_idThe unique identifier associated with the job.
System.Collections.Generic.IEnumerable<System.String>fieldsA json list of column names to return in the request.
System.StringfilterA json dictionary of a filter statement.
System.Nullable<System.Int32>pageThe page to return if using pagination.
System.Nullable<System.Int32>records_per_pageThe amount of records per page to return if using pagination.
System.Stringorder_bysA json dictionary containing an order by statement.
System.Stringactivity_status
System.Stringsearch_filter
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfocacheInfo
System.Int32[]mutedStatusCodes
System.Threading.CancellationTokencancellationTokenA 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.

Was this page helpful?