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

Class representing packet workflow step calls

Hierarchy

  • PlatformFormApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

addCommitteeMemberExclusion

  • addCommitteeMemberExclusion(__namedParameters: { committeeMemberId: number; originId: number; packetId: number }): Promise<boolean>

  • Exclude a particular committee member from submitting a form response

    example
    const omitted = await api.Tenure.PlatformForms.addCommitteeMemberExclusion({
 packetId: 9999,
 originId: 9999,
 committeeMemberId: 9999
})

    Parameters

    • __namedParameters: { committeeMemberId: number; originId: number; packetId: number }
      • committeeMemberId: number

        ID of the committee member

      • originId: number

        ID of the form instance attached to workflow step

      • packetId: number

        ID of the packet

    Returns Promise<boolean>

addWorkflowStepForm

  • Add a required form to a workflow step

    example
    let form = await api.Tenure.PlatformForms.addWorkflowStepForm({
  committeeId: 9999,
  committeeManagerOnlySubmission: false,
  formAccessLevel: 1,
  formId: 9999,
  packetId: 9999,
  sectionId: 9999
  workflowStepId: 9999
});

    Parameters

    Returns Promise<PlatformForm>

deleteForm

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

  • Delete a platform form

    example
     let deleted = await api.Tenure.PlatformForms.delete({id: 9999, packetId: 9999});

    Parameters

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

        id of the form instance

      • packetId: number

        id of the case packet

    Returns Promise<boolean>

excludeUnsubmittedResponses

  • excludeUnsubmittedResponses(__namedParameters: { originId: number; packetId: number }): Promise<boolean>

  • Exclude all unsubmmitted/un-omitted forms from the requirement to submit

    example
    const responders = await api.Tenure.PlatformForms.excludeUnsubmittedResponses({
 packetId: 9999,
 originId: 9999
});

    Parameters

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

        ID of the form instance assigned to the

      • packetId: number

        ID of the packet

    Returns Promise<boolean>

formSubmissionFromValues

  • given a form version and response values format the form submission

    note: just calls the static version of this function for backwards compatibility

    Parameters

    • __namedParameters: { formVersion: FormVersion; responseValues: { label: string; value: string | number }[] }
      • formVersion: FormVersion
      • responseValues: { label: string; value: string | number }[]

    Returns PlatformFormSubmission

getFormResponders

  • getFormResponders(__namedParameters: { originId: number; packetId: number }): Promise<PlatformFormResponder[]>

  • Get the list of assigned responders for a form instance

    example
    const responders = await api.Tenure.PlatformForms.getFormResponder({
 packetId: 9999,
 originId: 9999
});

    Parameters

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

        ID of the form instance assigned to the workflow step committee

      • packetId: number

        ID of the packet

    Returns Promise<PlatformFormResponder[]>

getFormVersionForWorkflowStep

  • getFormVersionForWorkflowStep(__namedParameters: { formId: number; originId: number }): Promise<FormVersion>

  • Get the form version associated with a form assigned to a workflow step

    example
    let formVersion = await api.Tenure.PlatformForms.getFormVersionForWorkflowStep({
 formId: 9999,
 originId: 9999
});

    Parameters

    • __namedParameters: { formId: number; originId: number }
      • formId: number

        the main form type id of the form

      • originId: number

        the form assignment instance to the workflow step

    Returns Promise<FormVersion>

removeCommitteeMemberExclusion

  • removeCommitteeMemberExclusion(__namedParameters: { committeeMemberId: number; originId: number; packetId: number }): Promise<boolean>

  • Remove a Previously Submitted Exclusion for a committee member for response

    example
    const nowRequired = await api.Tenure.PlatformForms.removeCommitteeMemberExclusion
 packetId: 9999,
 originId: 9999,
 committeeMemberId: 9999
})

    Parameters

    • __namedParameters: { committeeMemberId: number; originId: number; packetId: number }
      • committeeMemberId: number

        ID of the committee member

      • originId: number

        ID of the form instance

      • packetId: number

        ID of the packet

    Returns Promise<boolean>

resubmitCommitteeFormByValues

  • resubmitCommitteeFormByValues(__namedParameters: { committeeName: string; formTitle: string; packetId: number; responseValues: { label: string; value: string | number }[]; submitterEmail: string; workflowStepName: string }): Promise<PlatformFormSubmissionResponse>

  • Resubmit form response from values instead of ids

    example
    await api.Tenure.WorkflowStepCommittees.resubmitCommitteeFormByValues({
  packetId: 9999,
  workflowStepName: "Department Review",
  committeeName: "Department Committee",
  formTitle: "Department Information Form",
  submitterEmail: "dept_chair@example.com",
  responseValues: [{"label": "Question 1", "value": "Answer One"},{"label": "Question 2","value": "Answer 2"}]
});

    Parameters

    • __namedParameters: { committeeName: string; formTitle: string; packetId: number; responseValues: { label: string; value: string | number }[]; submitterEmail: string; workflowStepName: string }
      • committeeName: string

        committee name to which the form is assigned in the workflow step

      • formTitle: string

        name of the form to submit

      • packetId: number

        id of the packet

      • responseValues: { label: string; value: string | number }[]

        values to submit in the form of [{"label": "Question Label 1", "value": "Question value 1"}]

      • submitterEmail: string

        email address of the user who has already submitted a response

      • workflowStepName: string

        workflow step name which contains the form to update

    Returns Promise<PlatformFormSubmissionResponse>

resubmitFormResponse

  • Resubmit an existing form response

    example
    let formVersion await api.Tenure.PlatformForms.getFormVersionForWorkflowStep({
 formId: 9999,
 originId: 9999
});

let submission = api.Tenure.PlatformForms.formSubmissionFromValues({
  formVersion: formVersion,
  responseValues: [{label: "Question 1", value: "Answer 1}, {label: "Question 2", value: "answer 2"}]
};

let response = api.Tenure.PlatformForms.resubmitFormResponse({
  packetId: 9999,
  originId: 9999,
  responseId: 9999,
  submission: submission
}

    Parameters

    • __namedParameters: { originId: number; packetId: number; responseId: number; submission: PlatformFormSubmission }
      • originId: number

        id of the form assignment to the workflow step

      • packetId: number

        the packet id

      • responseId: number

        id of the existing form response

      • submission: PlatformFormSubmission

        the submission information

    Returns Promise<PlatformFormSubmissionResponse>

submitCommitteeFormByValues

  • submitCommitteeFormByValues(__namedParameters: { committeeName: string; formTitle: string; packetId: number; responseValues: { label: string; value: string | number }[]; workflowStepName: string }): Promise<PlatformFormSubmissionResponse>

  • Submit form response from values instead of ids

    example
    await api.Tenure.WorkflowStepCommittees.submitCommitteeFormByValues({
  packetId: 9999,
  workflowStepName: "Department Review",
  committeeName: "Department Committee",
  formTitle: "Department Information Form",
  responseValues: [{"label": "Question 1", "value": "Answer One"},{"label": "Question 2","value": "Answer 2"}]
});

    Parameters

    • __namedParameters: { committeeName: string; formTitle: string; packetId: number; responseValues: { label: string; value: string | number }[]; workflowStepName: string }
      • committeeName: string

        committee name to which the form is assigned in the workflow step

      • formTitle: string

        name of the form to submit

      • packetId: number

        id of the packet

      • responseValues: { label: string; value: string | number }[]

        values to submit in the form of [{"label": "Question Label 1", "value": "Question value 1"}]

      • workflowStepName: string

        workflow step name which contains the form to update

    Returns Promise<PlatformFormSubmissionResponse>

submitFormResponse

  • Submit a form response for the current user

    example
    let formVersion await api.Tenure.PlatformForms.getFormVersionForWorkflowStep({
 formId: 9999,
 originId: 9999
});

let submission = api.Tenure.PlatformForms.formSubmissionFromValues({
  formVersion: formVersion,
  responseValues: [{label: "Question 1", value: "Answer 1}, {label: "Question 2", value: "answer 2"}]
};

let response = api.Tenure.PlatformForms.submitFormResponse({
  packetId: 9999,
  originId: 9999,
  submission: submission
}

    Parameters

    • __namedParameters: { originId: number; packetId: number; submission: PlatformFormSubmission }
      • originId: number

        id of the platform form assigned as assigned to the workflow step

      • packetId: number

        the packet id

      • submission: PlatformFormSubmission

        the form submission

    Returns Promise<PlatformFormSubmissionResponse>

Static formSubmissionFromValues

Static valuesFromFormResponse

Legend

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

Generated using TypeDoc