sapiopycommons 2024.3.18a156__py3-none-any.whl → 2025.1.17a402__py3-none-any.whl

sapiopycommons/processtracking/custom_workflow_handler.py

@@ -0,0 +1,406 @@
+from typing import Iterable
+
+from sapiopylib.rest.User import SapioUser
+from sapiopylib.rest.pojo.CustomReport import CustomReportCriteria
+from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
+from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
+
+from sapiopycommons.customreport.custom_report_builder import CustomReportBuilder
+from sapiopycommons.datatype.data_fields import ProcessQueueItemFields, SystemFields, ProcessWorkflowTrackingFields
+from sapiopycommons.general.aliases import UserIdentifier, AliasUtil, SapioRecord
+from sapiopycommons.general.custom_report_util import CustomReportUtil
+from sapiopycommons.general.exceptions import SapioException
+from sapiopycommons.general.time_util import TimeUtil
+from sapiopycommons.recordmodel.record_handler import RecordHandler
+from sapiopycommons.webhook.webhook_context import ProcessQueueContext
+
+
+class QueueItemReportCriteria:
+    """
+    Queue item report criteria is used to restrict the results of searches for queue item records.
+    """
+    process_names: list[str] | None
+    not_process_names: list[str] | None
+    step_names: list[str] | None
+    not_step_names: list[str] | None
+    data_type_names: list[str] | None
+    not_data_type_names: list[str] | None
+    data_record_ids: list[int] | None
+    not_data_record_ids: list[int] | None
+    assigned_to: list[str] | None
+    not_assigned_to: list[str] | None
+    launched_after: int | None
+    launched_before: int | None
+    scheduled_after: int | None
+    scheduled_before: int | None
+    shown_in_queue: bool | None
+    has_experiment: bool | None
+
+    def __init__(self, *,
+                 process_names: list[str] | None = None,
+                 not_process_names: list[str] | None = None,
+                 step_names: list[str] | None = None,
+                 not_step_names: list[str] | None = None,
+                 data_type_names: list[str] | None = None,
+                 not_data_type_names: list[str] | None = None,
+                 data_record_ids: list[int] | None = None,
+                 not_data_record_ids: list[int] | None = None,
+                 assigned_to: list[str] | None = None,
+                 not_assigned_to: list[str] | None = None,
+                 launched_after: int | None = None,
+                 launched_before: int | None = None,
+                 scheduled_after: int | None = None,
+                 scheduled_before: int | None = None,
+                 shown_in_queue: bool | None = None,
+                 has_experiment: bool | None = None):
+        """
+        :param process_names: The allowed process name(s).
+        :param not_process_names: The disallowed process name(s).
+        :param step_names: The allowed step name(s).
+        :param not_step_names: The disallowed step name(s).
+        :param data_type_names: The allowed data type name(s).
+        :param not_data_type_names: The disallowed dta type name(s).
+        :param data_record_ids: The allowed record ID(s).
+        :param not_data_record_ids: The disallowed record ID(s).
+        :param assigned_to: The allowed username(s) of the user(s) that the queue items are assigned to.
+        :param not_assigned_to: The disallowed username(s) of the user(s) that the queue items are assigned to.
+        :param launched_after: A timestamp after which the queue item was launched.
+        :param launched_before: A timestamp before which the queue item was launched.
+        :param scheduled_after: A timestamp after which the queue item was scheduled.
+        :param scheduled_before: A timestamp before which the queue item was scheduled.
+        :param shown_in_queue: Whether the queue item is currently being shown in a queue.
+        :param has_experiment: Whether the queue item is linked to an experiment record.
+        """
+        self.process_names = process_names
+        self.not_process_names = not_process_names
+        self.step_names = step_names
+        self.not_step_names = not_step_names
+        self.data_type_names = data_type_names
+        self.not_data_type_names = not_data_type_names
+        self.data_record_ids = data_record_ids
+        self.not_data_record_ids = not_data_record_ids
+        self.assigned_to = assigned_to
+        self.not_assigned_to = not_assigned_to
+        self.launched_after = launched_after
+        self.launched_before = launched_before
+        self.scheduled_after = scheduled_after
+        self.scheduled_before = scheduled_before
+        self.shown_in_queue = shown_in_queue
+        self.has_experiment = has_experiment
+
+
+class QueueItemHandler:
+    """
+    A class used for handling the display of records in custom process queues, which are controlled in the system by
+    ProcessQueueItem data types.
+    """
+    user: SapioUser
+    context: ProcessQueueContext | None
+    rec_handler: RecordHandler
+
+    def __init__(self, context: UserIdentifier):
+        """
+        :param context: The current webhook context or a user object to send requests from.
+        """
+        self.user = AliasUtil.to_sapio_user(context)
+        self.rec_handler = RecordHandler(self.user)
+        if isinstance(context, SapioWebhookContext):
+            self.context = ProcessQueueContext(context)
+        else:
+            self.context = None
+
+    def get_process_queue_items_from_context(self, wrapper: type[WrappedType],
+                                             context: SapioWebhookContext | ProcessQueueContext | None = None) \
+            -> list[WrappedType]:
+        """
+        When you launch records from a custom process queue, the process queue items related to the selected records
+        are provided as record IDs to the process queue context. Using these record IDs, query for the queue item
+        records and wrap them as record models.
+
+        :param wrapper: The record model wrapper for the process queue items.
+        :param context: If this handler was not initialized with a context object, or you wish to retrieve
+            data from a different context object than the initializing context, then provide the context to retrieve the
+            record IDs from.
+        :return: The process queue items corresponding to the record IDs from the context wrapped as record models.
+        """
+        if context is None and self.context is not None:
+            record_ids: list[int] = self.context.process_queue_item_record_ids
+        elif context is not None:
+            if isinstance(context, SapioWebhookContext):
+                record_ids: list[int] = ProcessQueueContext(context).process_queue_item_record_ids
+            else:
+                record_ids: list[int] = context.process_queue_item_record_ids
+        else:
+            raise SapioException("A context object must be provided to this function call, as the handler "
+                                 "was not initialized with one.")
+        return self.rec_handler.query_models_by_id(wrapper, record_ids)
+
+    def map_records_to_queue_items(self, records: Iterable[SapioRecord], queue_items: Iterable[SapioRecord]) \
+            -> dict[SapioRecord, list[SapioRecord]]:
+        """
+        Given a list of records and a list of queue items, create a dictionary mapping the records to the queue items
+        that refer to them.
+
+        :param records: The records to map to the queue items.
+        :param queue_items: The queue items to map to the records.
+        :return: A dictionary of record to the queue items that refer to them. Input queue items that don't refer to
+            any provided records will not be in this dictionary.
+        """
+        ret_val: dict[SapioRecord, list[SapioRecord]] = {}
+        id_to_queue_items: dict[int, list[SapioRecord]] = self.rec_handler.map_by_field(queue_items,
+                                                                                        ProcessQueueItemFields.DATA_RECORD_ID__FIELD)
+        id_to_record: dict[int, SapioRecord] = self.rec_handler.map_by_id(records)
+        for record_id, record in id_to_record.items():
+            ret_val[record] = id_to_queue_items[record_id]
+        return ret_val
+
+    def map_queue_items_to_records(self, queue_items: Iterable[SapioRecord], records: Iterable[SapioRecord]) \
+            -> dict[SapioRecord, SapioRecord]:
+        """
+        Given a list of queue items and a list of records, create a dictionary mapping the queue items to the record
+        that they refer to.
+
+        :param queue_items: The queue items to map to the records.
+        :param records: The records to map to the queue items.
+        :return: A dictionary of queue items to the records that the refer to. Input record that aren't referred to by
+            any provided queue items will not be in this dictionary.
+        """
+        ret_val: dict[SapioRecord, SapioRecord] = {}
+        id_to_queue_items: dict[int, list[SapioRecord]] = self.rec_handler.map_by_field(queue_items,
+                                                                                        ProcessQueueItemFields.DATA_RECORD_ID__FIELD)
+        id_to_record: dict[int, SapioRecord] = self.rec_handler.map_by_id(records)
+        for record_id, queue_items in id_to_queue_items.items():
+            record: SapioRecord = id_to_record[record_id]
+            for queue_item in queue_items:
+                ret_val[queue_item] = record
+        return ret_val
+
+    def get_queue_items_from_report(self, wrapper: type[WrappedType], criteria: QueueItemReportCriteria) \
+            -> list[WrappedType]:
+        """
+        Run a custom report that retrieves every queue item in the system for the given search criteria.
+
+        :param wrapper: The record model wrapper for the process queue items.
+        :param criteria: The search criteria to query for queue items with.
+        :return: A list of every queue item in the system that matches the search criteria.
+        """
+        report = self.build_queue_item_report(criteria)
+        return self.rec_handler.query_models_by_report(wrapper, report)
+
+    def get_records_from_item_report(self, wrapper: type[WrappedType],
+                                     criteria: QueueItemReportCriteria = QueueItemReportCriteria()) -> list[WrappedType]:
+        """
+        Run a custom report that retrieves for queue items that match the given search criteria, then query for the
+        data records that those queue items refer to.
+
+        :param wrapper: The record model wrapper for the records being queried for.
+        :param criteria: Additional search criteria to filter the results. This function forces the data_type_names
+            parameter of the criteria to match the data type of the given record model wrapper.
+        :return: A list of all records related to the queue items in the system that match the search criteria.
+        """
+        # Don't try to query for process queue items that don't match the data type of this wrapper.
+        criteria.data_type_names = [wrapper.get_wrapper_data_type_name()]
+        criteria.not_data_type_names = None
+        report = self.build_queue_item_report(criteria)
+        record_ids: list[int] = [x[ProcessQueueItemFields.DATA_RECORD_ID__FIELD.field_name]
+                                 for x in CustomReportUtil.run_custom_report(self.user, report)]
+        return self.rec_handler.query_models_by_id(wrapper, record_ids)
+
+    def get_queue_items_for_records(self, records: Iterable[SapioRecord], wrapper: type[WrappedType],
+                                    criteria: QueueItemReportCriteria = QueueItemReportCriteria()) \
+            -> dict[SapioRecord, list[WrappedType]]:
+        """
+        Given a list of records, query the system for every process queue item that refers to those records and matches
+        the provided search criteria.
+
+        :param records: The queued records to query for the process queue items of.
+        :param wrapper: The record model wrapper for the returned process queue item records.
+        :param criteria: Additional search criteria to filter the results. This function forces the data_record_ids and
+            data_type_names parameters on the criteria to match the given records.
+        :return: A dictionary mapping the input records to a list of the process queue items that refer to them. If a
+            record does not have any queue items that refer to it that match the given search criteria, then it will
+            map to an empty list.
+        """
+        # Query for only those process queue items that have a record ID from the provided records.
+        criteria.data_record_ids = AliasUtil.to_record_ids(records)
+        criteria.not_data_record_ids = None
+        criteria.data_type_names = AliasUtil.to_data_type_names(records)
+        criteria.not_data_type_names = None
+        items: list[WrappedType] = self.get_queue_items_from_report(wrapper, criteria)
+        return self.map_records_to_queue_items(records, items)
+
+    def get_records_for_queue_items(self, queue_items: Iterable[SapioRecord], wrapper: type[WrappedType]) \
+            -> dict[SapioRecord, WrappedType]:
+        """
+        Given a list of process queue items, query the system for the records that those queue items refer to.
+
+        :param queue_items: The process queue items to query for the referenced records of.
+        :param wrapper: The record model wrapper for the records being queried.
+        :return: A dictionary mapping the input process queue items to the record tht they refer to.
+        """
+        record_ids: set[int] = {x.get_field_value(ProcessQueueItemFields.DATA_RECORD_ID__FIELD) for x in queue_items}
+        records: list[WrappedType] = self.rec_handler.query_models_by_id(wrapper, record_ids)
+        return self.map_queue_items_to_records(queue_items, records)
+
+    def queue_records_for_process(self, records: Iterable[SapioRecord], process: str, step: str,
+                                  wrapper: type[WrappedType]) -> dict[SapioRecord, WrappedType]:
+        """
+        Given a list of records, create process queue item records for them at the provided process and step names.
+        You must store and commit using the record model manager in order for these changes to take effect.
+
+        :param records: The records to create process queue items for.
+        :param wrapper: The record model wrapper for the process queue items being created.
+        :param process: The name of the process to queue for.
+        :param step: The name of the step in the above process to queue for. This is the "Workflow Name" field of the
+            Process Workflow record corresponding to the step you want to assign these records to. For steps that
+            launch an experiment, this is the name of the template that will be launched. For the other types of custom
+            process steps, this is the "Workflow Name" as defined in the process manager config.
+        :return: A dictionary mapping each input record to the newly created process queue item for that record.
+        """
+        ret_val: dict[SapioRecord, WrappedType] = {}
+        for record in records:
+            item = self.rec_handler.add_model(wrapper)
+            item.set_field_values({
+                ProcessQueueItemFields.PROCESS_HEADER_NAME__FIELD.field_name: process,
+                ProcessQueueItemFields.WORKFLOW_HEADER_NAME__FIELD.field_name: step,
+                ProcessQueueItemFields.SHOW_IN_QUEUE__FIELD.field_name: True,
+                ProcessQueueItemFields.SCHEDULED_DATE__FIELD.field_name: TimeUtil.now_in_millis(),
+                ProcessQueueItemFields.DATA_RECORD_ID__FIELD.field_name: AliasUtil.to_record_id(record),
+                ProcessQueueItemFields.DATA_TYPE_NAME__FIELD.field_name: AliasUtil.to_data_type_name(record)
+            })
+            ret_val[record] = item
+        return ret_val
+
+    def dequeue_records_for_process(self, records: Iterable[SapioRecord], wrapper: type[WrappedType],
+                                    criteria: QueueItemReportCriteria = QueueItemReportCriteria()) \
+            -> dict[SapioRecord, list[WrappedType]]:
+        """
+        Given a list of records, locate the process queue items that refer to them and that match the given search
+        criteria and remove them from the queue by setting the ShowInQueue field on the process queue items to false.
+        You must store and commit using the record model manager in order for these changes to take effect.
+
+        :param records: The records to remove from the queue.
+        :param wrapper: The record model wrapper for the process queue items being updated.
+        :param criteria: Additional search criteria to filter the results. This function forces the show_in_queue
+            parameter on the criteria to True.
+        :return: A dictionary mapping each input record to the queue item records that refer to that record and were
+            updated. If a record does not have any queue items that refer to it that match the given search criteria,
+            then it will map to an empty list.
+        """
+        # Only locate queue items that are currently visible in the queue.
+        criteria.shown_in_queue = True
+        dequeue: dict[SapioRecord, list[WrappedType]] = self.get_queue_items_for_records(records, wrapper, criteria)
+        for record, items in dequeue.items():
+            for item in items:
+                item.set_field_value(ProcessQueueItemFields.SHOW_IN_QUEUE__FIELD.field_name, False)
+        return dequeue
+
+    @staticmethod
+    def assigned_queue_items(queue_items: Iterable[SapioRecord], assign_to: list[str]) -> None:
+        """
+        Given a collection of queue items, assign them to a list of usernames or group names. Only those users in the
+        listed groups or those users with the matching username will be able to see these related records in the process
+        queue.
+        You must store and commit using the record model manager in order for these changes to take effect.
+
+        :param queue_items: The queue items to assign.
+        :param assign_to: A list of usernames and/or group names to assign these items to.
+        """
+        for item in queue_items:
+            item.set_field_value(ProcessQueueItemFields.ASSIGNED_TO__FIELD, ",".join(assign_to))
+
+    def get_queue_item_workflow_trackers(self, items: Iterable[SapioRecord], wrapper: type[WrappedType]) \
+            -> dict[SapioRecord, list[WrappedType]]:
+        """
+        When a queue item is launched into a process step, a ProcessWorkflowTracking record is created by the system
+        with a side link to the process queue item. This record records information about how long the record ws in
+        the queue, among other details.
+
+        Retrieve the workflow tracker records for the input queue items.
+
+        :param items: The queue items to load the workflow trackers of.
+        :param wrapper: The record model wrapper for the ProcessWorkflowTracking records.
+        :return: A dictionary mapping each queue item to the workflow trackers that side link to that item. If an input
+            queue item doesn't have any workflow trackers, then it will map to an empty list.
+        """
+        field: str = ProcessWorkflowTrackingFields.PROCESS_QUEUE_ITEM__FIELD.field_name
+        self.rec_handler.rel_man.load_reverse_side_links_of_type(list(items), wrapper, field)
+        return self.rec_handler.map_to_reverse_side_links(items, field, wrapper)
+
+    @staticmethod
+    def build_queue_item_report(criteria: QueueItemReportCriteria) -> CustomReportCriteria:
+        """
+        Construct a custom report using the provided QueueItemReportCriteria.
+
+        :param criteria: The criteria to construct a custom report from.
+        :return: A custom report that can be used to search for queue items that match the given criteria.
+        """
+        dt: str = ProcessQueueItemFields.DATA_TYPE_NAME
+        report_builder = CustomReportBuilder(dt)
+        tb = report_builder.get_term_builder()
+        report_builder.add_column(SystemFields.RECORD_ID__FIELD)
+        report_builder.add_column(ProcessQueueItemFields.DATA_RECORD_ID__FIELD)
+
+        root = tb.all_records_term()
+
+        if criteria.process_names is not None:
+            term = tb.is_term(ProcessQueueItemFields.PROCESS_HEADER_NAME__FIELD, criteria.process_names)
+            root = tb.and_terms(root, term)
+        if criteria.not_process_names is not None:
+            term = tb.not_term(ProcessQueueItemFields.PROCESS_HEADER_NAME__FIELD, criteria.not_process_names)
+            root = tb.and_terms(root, term)
+
+        if criteria.step_names is not None:
+            term = tb.is_term(ProcessQueueItemFields.WORKFLOW_HEADER_NAME__FIELD, criteria.step_names)
+            root = tb.and_terms(root, term)
+        if criteria.not_step_names is not None:
+            term = tb.not_term(ProcessQueueItemFields.WORKFLOW_HEADER_NAME__FIELD, criteria.not_step_names)
+            root = tb.and_terms(root, term)
+
+        if criteria.data_type_names is not None:
+            term = tb.is_term(ProcessQueueItemFields.DATA_TYPE_NAME__FIELD, criteria.data_type_names)
+            root = tb.and_terms(root, term)
+        if criteria.not_data_type_names is not None:
+            term = tb.not_term(ProcessQueueItemFields.DATA_TYPE_NAME__FIELD, criteria.not_data_type_names)
+            root = tb.and_terms(root, term)
+
+        if criteria.data_record_ids is not None:
+            term = tb.is_term(ProcessQueueItemFields.DATA_RECORD_ID__FIELD, criteria.data_record_ids)
+            root = tb.and_terms(root, term)
+        if criteria.not_data_record_ids is not None:
+            term = tb.not_term(ProcessQueueItemFields.DATA_RECORD_ID__FIELD, criteria.not_data_record_ids)
+            root = tb.and_terms(root, term)
+
+        if criteria.assigned_to is not None:
+            term = tb.is_term(ProcessQueueItemFields.ASSIGNED_TO__FIELD, criteria.assigned_to)
+            root = tb.and_terms(root, term)
+        if criteria.not_assigned_to is not None:
+            term = tb.not_term(ProcessQueueItemFields.ASSIGNED_TO__FIELD, criteria.not_assigned_to)
+            root = tb.and_terms(root, term)
+
+        if criteria.launched_after is not None:
+            term = tb.gte_term(ProcessQueueItemFields.LAUNCHED_DATE__FIELD, criteria.launched_after)
+            root = tb.and_terms(root, term)
+        if criteria.launched_before is not None:
+            term = tb.lte_term(ProcessQueueItemFields.LAUNCHED_DATE__FIELD, criteria.launched_before)
+            root = tb.and_terms(root, term)
+
+        if criteria.scheduled_after is not None:
+            term = tb.gte_term(ProcessQueueItemFields.LAUNCHED_DATE__FIELD, criteria.scheduled_after)
+            root = tb.and_terms(root, term)
+        if criteria.scheduled_before is not None:
+            term = tb.lte_term(ProcessQueueItemFields.LAUNCHED_DATE__FIELD, criteria.scheduled_before)
+            root = tb.and_terms(root, term)
+
+        if criteria.shown_in_queue is not None:
+            term = tb.is_term(ProcessQueueItemFields.SHOW_IN_QUEUE__FIELD, criteria.shown_in_queue)
+            root = tb.and_terms(root, term)
+        if criteria.has_experiment is not None:
+            if criteria.has_experiment:
+                term = tb.not_term(ProcessQueueItemFields.EXPERIMENT__FIELD, None)
+            else:
+                term = tb.is_term(ProcessQueueItemFields.EXPERIMENT__FIELD, None)
+            root = tb.and_terms(root, term)
+
+        report_builder.set_root_term(root)
+        return report_builder.build_report_criteria()

sapiopycommons/processtracking/endpoints.py

@@ -0,0 +1,192 @@
+from sapiopylib.rest.User import SapioUser
+
+from sapiopycommons.general.aliases import RecordIdentifier, AliasUtil, ExperimentIdentifier, DataTypeIdentifier, \
+    UserIdentifier
+
+
+class ProcessTracking:
+    @staticmethod
+    def assign_to_process(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+                          process_name: str, step_number: int | None = None, branch_id: int | None = None,
+                          request: RecordIdentifier | None = None) -> None:
+        """
+        Assign the given tracked records to a new process at the specified step, settings its status to "Ready for -"
+        at that step.
+        Synonymous with what occurs during request creation or when using the assign to process button.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param data_type: The data type of the tracked records.
+        :param records: A list of the tracked records.
+        :param process_name: The name of the process that the tracked records should start at.
+        :param step_number: The step number that the tracked records should start at. If not provided, assumes step
+            number 1.
+        :param branch_id: The branch ID of the above step. Only necessary to provide if multiple steps in the process
+            share the same step number.
+        :param request: The request that the tracked records are a part of, to be used for the assigned process record's
+            request record ID field. If none is provided, creates a new request with default fields.
+        """
+        sub_path = '/ext/process-tracking/assign-to-process'
+        payload = {
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
+            "record-ids": AliasUtil.to_record_ids(records),
+            "process-name": process_name,
+            "step-number": step_number,
+            "branch-id": branch_id,
+            "request-record-id": AliasUtil.to_record_ids([request])[0] if request is not None else None
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.post(sub_path, payload=payload)
+        user.raise_for_status(response)
+
+    @staticmethod
+    def begin_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+                       experiment: ExperimentIdentifier) -> None:
+        """
+        Begin the assigned processes of the given tracked records as the given experiment. This sets the status of the
+        tracked records from "Ready for -" to "In Process -" for their current step.
+        Synonymous with what occurs when starting a process step in the system.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param data_type: The data type of the tracked records.
+        :param records: A list of the tracked records.
+        :param experiment: The experiment that the tracked records are beginning the process for. This must be the next
+            step in the current process of the tracked records.
+        """
+        sub_path = '/ext/process-tracking/begin-protocol'
+        payload = {
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
+            "record-ids": AliasUtil.to_record_ids(records),
+            "experiment-id": AliasUtil.to_notebook_id(experiment),
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.post(sub_path, payload=payload)
+        user.raise_for_status(response)
+
+    @staticmethod
+    def complete_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+                          experiment: ExperimentIdentifier) -> None:
+        """
+        Complete the current step that the given tracked records are at given the experiment.
+        Moves the status to "Ready for -" for the next step in the process, or "Completed -" if this was the last
+        step.
+        Moves the status to "Failed -" if the failed flag for the tracked record is true.
+        Moves the assigned process down to the descendant sample(s) if both samples are provided in the records list.
+        Synonymous with what occurs when completing an experiment in the system.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param data_type: The data type of the tracked records.
+        :param records: A list of the tracked records.
+        :param experiment: The experiment that the tracked records are currently in and completing.
+        """
+        sub_path = '/ext/process-tracking/complete-protocol'
+        payload = {
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
+            "record-ids": AliasUtil.to_record_ids(records),
+            "experiment-id": AliasUtil.to_notebook_id(experiment),
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.post(sub_path, payload=payload)
+        user.raise_for_status(response)
+
+    @staticmethod
+    def fail(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+             experiment: ExperimentIdentifier) -> None:
+        """
+        Fail the assigned processes of the given tracked records, changing their statuses to "Failed -". The tracked
+        records must be "In Process -" for the given step.
+        Synonymous with what occurs when failing a sample due to a QC failure in a process in the system.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param data_type: The data type of the tracked records.
+        :param records: A list of the tracked records.
+        :param experiment: The experiment that the tracked records are currently in.
+        """
+        sub_path = '/ext/process-tracking/fail'
+        payload = {
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
+            "record-ids": AliasUtil.to_record_ids(records),
+            "experiment-id": AliasUtil.to_notebook_id(experiment),
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.post(sub_path, payload=payload)
+        user.raise_for_status(response)
+
+    @staticmethod
+    def promote_to_next_by_experiment(context: UserIdentifier, data_type: DataTypeIdentifier,
+                                      records: list[RecordIdentifier], experiment: ExperimentIdentifier) -> None:
+        """
+        Promote the status of the given tracked records to the next status in their process using an experiment.
+        If the tracked records currently have a status of "Ready for -", then providing an experiment of the template
+        they are ready for will move their status to "In Process -" for the experiment.
+        If the tracked records currently have a status of "In Process -", then providing their current experiment
+        will move their status to "Ready for -" for the next step in the process, or "Completed -" if this was the
+        last step.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param data_type: The data type of the tracked records.
+        :param records: A list of the tracked records.
+        :param experiment: The experiment that the tracked records are currently in.
+        """
+        sub_path = '/ext/process-tracking/promote-status-to-next'
+        payload = {
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
+            "record-ids": AliasUtil.to_record_ids(records),
+            "experiment-id": AliasUtil.to_notebook_id(experiment),
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.post(sub_path, payload=payload)
+        user.raise_for_status(response)
+
+    @staticmethod
+    def promote_to_next_by_step(context: UserIdentifier, data_type: DataTypeIdentifier,
+                                records: list[RecordIdentifier], process_name: str, step_number: int,
+                                branch_id: int | None = None) -> None:
+        """
+        Promote the status of the given tracked records to the next status in their process using step info.
+        If the tracked records currently have a status of "Ready for -", then providing the step info for their current
+        step will move their status to "In Process -" for that step.
+        If the tracked records currently have a status of "In Process -", then providing the step info for their current
+        step will move their status to "Ready for -" for the next step in the process, or "Completed -" if this was the
+        last step.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param data_type: The data type of the tracked records.
+        :param records: A list of the tracked records.
+        :param process_name: The name of the process that the tracked records are currently in.
+        :param step_number: The step number that the tracked records are currently in.
+        :param branch_id: The branch ID of the above step. Only necessary to provide if multiple steps in the process
+            share the same step number.
+        """
+        sub_path = '/ext/process-tracking/promote-status-to-next'
+        payload = {
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
+            "record-ids": AliasUtil.to_record_ids(records),
+            "current-process-status": {
+                "process-name": process_name,
+                "step-number": step_number,
+                "branch-id": branch_id
+            }
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.post(sub_path, payload=payload)
+        user.raise_for_status(response)
+
+    @staticmethod
+    def reprocess(context: UserIdentifier, records: list[RecordIdentifier]) -> None:
+        """
+        Reprocess tracked records to a previous step in their process. Reprocessing is controlled by ReturnPoint records
+        which are children of the AssignedProcess on the tracked records. Creates a new AssignedProcess record for the
+        effected tracked records. Any existing AssignedProcess records are untouched.
+        Synonymous with what occurs when reprocessing records to a previous step due to QC failures in a process in the
+        system.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param records: A list of ReturnPoint records to reprocess to.
+        """
+        sub_path = '/ext/process-tracking/reprocess'
+        payload = {
+            "record-ids": AliasUtil.to_record_ids(records)
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.post(sub_path, payload=payload)
+        user.raise_for_status(response)