Interfolio API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class representing packet workflow step calls

Hierarchy

  • WorkflowStepApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Committees

Committees: WorkflowStepCommitteeApi

Handle to the WorkflowStepCommitteeApi

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

addWorkflowStepStanding

  • addWorkflowStepStanding(__namedParameters: { committeeId: number; packetId: number; workflowStepDueDate?: string; workflowStepName: string; workflowStepNote?: string }): Promise<WorkflowStep>

  • Add a workflow step with a standing committee

    example
    let step = await api.Tenure.WorkflowSteps.addWorkflowStepStanding({
  packetId: 9999,
  workflowStepName: "Workflow Step 3",
  committeeId: 9999,
  workflowStepNote: "Please review and send forward"
};

    Parameters

    • __namedParameters: { committeeId: number; packetId: number; workflowStepDueDate?: string; workflowStepName: string; workflowStepNote?: string }
      • committeeId: number

        id of the standing committee for the step

      • packetId: number

        packet id

      • Optional workflowStepDueDate?: string

        due date for the workflow step

      • workflowStepName: string

        name of the workflow step

      • Optional workflowStepNote?: string

        note for the workflow step

    Returns Promise<WorkflowStep>

deleteWorkflowStep

  • deleteWorkflowStep(__namedParameters: { id: number; packetId: number }): Promise<boolean>

  • Delete an existing workflow step

    example
    await api.Tenure.WorkflowSteps.deleteWorkflowStep({id: 9999, packetId: 9999});

    Parameters

    • __namedParameters: { id: number; packetId: number }
      • id: number

        ID of the workflow step

      • packetId: number

        ID of the packet

    Returns Promise<boolean>

getWorkflowStep

  • getWorkflowStep(__namedParameters: { packetId: number; workflowStepId: number }): Promise<WorkflowStep>

  • Get the workflow step

    example
    let step = await api.Tenure.WorkflowStep.getWorkflowStep({packetId: 9999, workflowStepId: 9999});

    Parameters

    • __namedParameters: { packetId: number; workflowStepId: number }
      • packetId: number

        packet id of the workflow step

      • workflowStepId: number

        workflow step id

    Returns Promise<WorkflowStep>

reorderWorkflowSteps

  • reorderWorkflowSteps(__namedParameters: { orderedWorkflowStepIds: number[]; packetId: number }): Promise<boolean>

  • Reorder the workflow steps

    example

    Parameters

    • __namedParameters: { orderedWorkflowStepIds: number[]; packetId: number }
      • orderedWorkflowStepIds: number[]

        array of workflow step ids in the desired order (do not include 0th step id)

      • packetId: number

        Id of the packet to reorder the steps for

    Returns Promise<boolean>

update

  • update(__namedParameters: { dueDate?: string; name: string; packetId: number; workflowStepId: number }): Promise<boolean>

  • Updates the name and due date for a workflow step

    example
    const updated = await api.Tenure.WorkflowStep.update({
  packetId: 9999,
  workflowStepId: 9999,
  name: "New Workflow Step Name"
  dueDate: '2021-01-01'
});

    Parameters

    • __namedParameters: { dueDate?: string; name: string; packetId: number; workflowStepId: number }
      • Optional dueDate?: string

        Due Date for the workflow step (YYYY-MM-DD)

      • name: string

        Name of the workflow step

      • packetId: number

        ID of the Packet

      • workflowStepId: number

        ID of the Workflow Step

    Returns Promise<boolean>

Static findWorkflowStepFromName

  • findWorkflowStepFromName(__namedParameters: { packetDetail: PacketDetail; workflowStepName: string }): null | WorkflowStep

  • Get workflow step from packet detail and workflow step name

    example
    import WorkflowStepApi from "@sas-irad/interfolio-api/lib/tenure/packets/workflow-step-api";
const detail = await api.Tenure.Packets.getDetail(9999);
const workflowStep = WorkflowStepApi.getWorkflowStepFromName({
  packetDetail: detail,
  sectionName: "Section Name"
};

    Parameters

    • __namedParameters: { packetDetail: PacketDetail; workflowStepName: string }
      • packetDetail: PacketDetail

        Packet Detail object

      • workflowStepName: string

        Name of the workflow step

    Returns null | WorkflowStep

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias
  • Static method

Generated using TypeDoc