published on Thursday, Aug 20, 2026 by jschady
published on Thursday, Aug 20, 2026 by jschady
A Form Field Set is a custom form to be used for bundle and inbox registrations.
Each Form Field Set contains one or more Form Fields. A form and all of its form fields are submitted in a single create request. The order of form fields in the array is the order they will be displayed.
Once created, a form field set can then be associated with one or more bundle(s) and/or inbox(s). Once associated, you will be required to submit well-formatted form-data when creating a bundle-registration or inbox registration.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";
const exampleFormFieldSet = filescom.getFormFieldSet({
id: 1,
});
import pulumi
import pulumi_filescom as filescom
example_form_field_set = filescom.get_form_field_set(id=1)
package main
import (
"github.com/jschady/pulumi-filescom/sdk/go/filescom"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := filescom.GetFormFieldSet(ctx, &filescom.LookupFormFieldSetArgs{
Id: 1,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;
return await Deployment.RunAsync(() =>
{
var exampleFormFieldSet = Filescom.GetFormFieldSet.Invoke(new()
{
Id = 1,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import com.pulumi.filescom.inputs.GetFormFieldSetArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var exampleFormFieldSet = FilescomFunctions.getFormFieldSet(GetFormFieldSetArgs.builder()
.id(1)
.build());
}
}
variables:
exampleFormFieldSet:
fn::invoke:
function: filescom:getFormFieldSet
arguments:
id: 1
pulumi {
required_providers {
filescom = {
source = "pulumi/filescom"
}
}
}
data "filescom_getformfieldset" "exampleFormFieldSet" {
id = 1
}
Using getFormFieldSet
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getFormFieldSet(args: GetFormFieldSetArgs, opts?: InvokeOptions): Promise<GetFormFieldSetResult>
function getFormFieldSetOutput(args: GetFormFieldSetOutputArgs, opts?: InvokeOutputOptions): Output<GetFormFieldSetResult>def get_form_field_set(id: Optional[int] = None,
opts: Optional[InvokeOptions] = None) -> GetFormFieldSetResult
def get_form_field_set_output(id: pulumi.Input[Optional[int]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetFormFieldSetResult]func LookupFormFieldSet(ctx *Context, args *LookupFormFieldSetArgs, opts ...InvokeOption) (*LookupFormFieldSetResult, error)
func LookupFormFieldSetOutput(ctx *Context, args *LookupFormFieldSetOutputArgs, opts ...InvokeOption) LookupFormFieldSetResultOutput> Note: This function is named LookupFormFieldSet in the Go SDK.
public static class GetFormFieldSet
{
public static Task<GetFormFieldSetResult> InvokeAsync(GetFormFieldSetArgs args, InvokeOptions? opts = null)
public static Output<GetFormFieldSetResult> Invoke(GetFormFieldSetInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetFormFieldSetResult> Invoke(GetFormFieldSetInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetFormFieldSetResult> getFormFieldSet(GetFormFieldSetArgs args, InvokeOptions options)
public static Output<GetFormFieldSetResult> getFormFieldSet(GetFormFieldSetArgs args, InvokeOptions options)
public static Output<GetFormFieldSetResult> getFormFieldSet(GetFormFieldSetArgs args, InvokeOutputOptions options)
fn::invoke:
function: filescom:index/getFormFieldSet:getFormFieldSet
arguments:
# arguments dictionarydata "filescom_get_form_field_set" "name" {
# arguments
}The following arguments are supported:
- Id int
- Form field set id
- Id int
- Form field set id
- id number
- Form field set id
- id Integer
- Form field set id
- id number
- Form field set id
- id int
- Form field set id
- id Number
- Form field set id
getFormFieldSet Result
The following output properties are available:
- Form
Fields object - Associated form fields
- Form
Layouts List<int> - Layout of the form
- Id int
- Form field set id
- In
Use bool - Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
- Skip
Company bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
- Skip
Email bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
- Skip
Name bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
- Title string
- Title to be displayed
- Form
Fields interface{} - Associated form fields
- Form
Layouts []int - Layout of the form
- Id int
- Form field set id
- In
Use bool - Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
- Skip
Company bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
- Skip
Email bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
- Skip
Name bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
- Title string
- Title to be displayed
- form_
fields any - Associated form fields
- form_
layouts list(number) - Layout of the form
- id number
- Form field set id
- in_
use bool - Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
- skip_
company bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
- skip_
email bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
- skip_
name bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
- title string
- Title to be displayed
- form
Fields Object - Associated form fields
- form
Layouts List<Integer> - Layout of the form
- id Integer
- Form field set id
- in
Use Boolean - Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
- skip
Company Boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
- skip
Email Boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
- skip
Name Boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
- title String
- Title to be displayed
- form
Fields any - Associated form fields
- form
Layouts number[] - Layout of the form
- id number
- Form field set id
- in
Use boolean - Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
- skip
Company boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
- skip
Email boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
- skip
Name boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
- title string
- Title to be displayed
- form_
fields Any - Associated form fields
- form_
layouts Sequence[int] - Layout of the form
- id int
- Form field set id
- in_
use bool - Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
- skip_
company bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
- skip_
email bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
- skip_
name bool - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
- title str
- Title to be displayed
- form
Fields Any - Associated form fields
- form
Layouts List<Number> - Layout of the form
- id Number
- Form field set id
- in
Use Boolean - Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
- skip
Company Boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
- skip
Email Boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
- skip
Name Boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
- title String
- Title to be displayed
Package Details
- Repository
- filescom jschady/pulumi-filescom
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
filescomTerraform Provider.
published on Thursday, Aug 20, 2026 by jschady