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

Index

References

Classes

Type aliases

References

default

Renames and exports WorkflowStepCommitteeApi

Type aliases

CommitteeDocumentRequirement

CommitteeDocumentRequirement: { created_at: string; description?: string; id: number; name: string; packet_attachment_id?: number; updated_at: string; workflow_step_committee_id: number }

A specified type for th

Type declaration

  • created_at: string

    date requirement was created

  • Optional description?: string

    description of the requirement

  • id: number

    id of the requirement

  • name: string

    name of the required document

  • Optional packet_attachment_id?: number

    id of the attachment fulfilling the document

  • updated_at: string

    date requirement was updated

  • workflow_step_committee_id: number

    name of the workflow step committee id

CommitteeFormRequirement

CommitteeFormRequirement: { caasbox_form_id: number; committee_id: number; committee_manager_only_submission: boolean; created_at: "Apr 28; 2021 at 8:33 AM"; form_access_level: number; form_name: string; has_responses: boolean; id: number; packet_section_id: number; packet_section_name: string; sort_order: number; updated_at: string; workflow_step_id: number }

Data concerning a form which has been assigned as a requirement to a workflow step committee

Type declaration

  • caasbox_form_id: number

    id of the overall form type

  • committee_id: number

    id of the committee assigned to complete the form

  • committee_manager_only_submission: boolean

    if the form is for committee manager submission only

  • created_at: "Apr 28; 2021 at 8:33 AM"

    date the form requirement was first created

  • form_access_level: number

    accesss level indiciating which roles can view the form informtion

  • form_name: string

    name of the form

  • has_responses: boolean

    if the form has reponses submitted yet

  • id: number

    Id of the form as assigned to the workflow step

  • packet_section_id: number

    section_id of the packet section where the form data will be put

  • packet_section_name: string

    packet section name where the form information will be included

  • sort_order: number

    order for the form among all required forms for the workflow step

  • updated_at: string

    date the form requirement was updated

  • workflow_step_id: number

    id of the associated workflow step

CommitteeRequirements

CommitteeRequirements: { required_documents: CommitteeDocumentRequirement[]; required_platform_forms: CommitteeFormRequirement[] }

The requirements specified for a workflow step committee

Type declaration

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc