Frodo Library - v4.0.0-24
    Preparing search index...

    Type Alias RequestForm

    type RequestForm = {
        deleteOrphanedRequestFormAssignments(
            formId?: string,
            workflowId?: string,
            applicationId?: string,
            requestTypeId?: string,
            onlyWorkflow?: boolean,
            resultCallback?: ResultCallback<RequestFormAssignment>,
        ): Promise<RequestFormAssignment[]>;
        deleteRequestForm(formId: string): Promise<RequestFormSkeleton>;
        deleteRequestFormByName(formName: string): Promise<RequestFormSkeleton>;
        deleteRequestForms(
            resultCallback?: ResultCallback<RequestFormSkeleton>,
        ): Promise<RequestFormSkeleton[]>;
        exportRequestForm(
            formId: string,
            options?: RequestFormExportOptions,
        ): Promise<RequestFormExportInterface>;
        exportRequestFormByName(
            formName: string,
            options?: RequestFormExportOptions,
        ): Promise<RequestFormExportInterface>;
        exportRequestForms(
            options?: RequestFormExportOptions,
            resultCallback?: ResultCallback<RequestFormExportInterface>,
        ): Promise<RequestFormExportInterface>;
        importRequestForms(
            importData: RequestFormExportInterface,
            formId?: string,
            formName?: string,
            options?: RequestFormImportOptions,
            resultCallback?: ResultCallback<RequestFormSkeleton>,
        ): Promise<RequestFormSkeleton[]>;
        readRequestForm(formId: string): Promise<RequestFormSkeleton>;
        readRequestFormByName(formName: string): Promise<RequestFormSkeleton>;
        readRequestForms(): Promise<RequestFormSkeleton[]>;
        updateRequestForm(
            formId: string,
            formData: RequestFormSkeleton,
        ): Promise<RequestFormSkeleton>;
    }
    Index

    Methods

    deleteOrphanedRequestFormAssignments deleteRequestForm deleteRequestFormByName deleteRequestForms exportRequestForm exportRequestFormByName exportRequestForms importRequestForms readRequestForm readRequestFormByName readRequestForms updateRequestForm

    Methods

    • Delete orphaned request form assignments. If no ids are specified, it will remove all orphans

      Parameters

      • OptionalformId: string

        The optional request form id. If specified, deletes orphaned assignments for the specified form.

      • OptionalworkflowId: string

        The optional workflow id. If specified, deletes orphaned assignments for the specified workflow.

      • OptionalapplicationId: string

        The optional application id. If specified, deletes orphaned assignments for the specified application.

      • OptionalrequestTypeId: string

        The optional request type id. If specified, deletes orphaned assignments for the specified request type.

      • OptionalonlyWorkflow: boolean

        Optional flag to return only workflow related assignments. Default: false

      • OptionalresultCallback: ResultCallback<RequestFormAssignment>

        Optional callback to process individual results

      Returns Promise<RequestFormAssignment[]>

      the deleted orphaned form assignments

    • Delete request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.

      Parameters

      • formName: string

        the request form name

      Returns Promise<RequestFormSkeleton>

      a promise that resolves to a request form object

    • Read request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.

      Parameters

      • formName: string

        the request form name

      Returns Promise<RequestFormSkeleton>

      a promise that resolves to a request form object

    Settings

    Member Visibility

    On This Page

    Methods