Skip to main content

CreateFormInstanceRequest

Properties

NameTypeDescriptionNotes
CreatedByFormInstanceCreatedBy[required]
ExpireStringExpire is required[required]
FormDefinitionIdStringFormDefinitionID is the id of the form definition that created this form[required]
FormInput[map[string]AnyType]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4FormInput is an object of form input labels to value[optional]
Recipients[]FormInstanceRecipientRecipients is required[required]
StandAloneFormBooleanStandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form[optional] [default to $false]
StateEnum [ "ASSIGNED", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "CANCELLED" ]State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled[optional]
TtlInt64TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html[optional]

Examples

  • Prepare the resource
$CreateFormInstanceRequest = Initialize-PSSailpoint.V2024CreateFormInstanceRequest  -CreatedBy null `
-Expire 2023-08-12T20:14:57.74486Z `
-FormDefinitionId 00000000-0000-0000-0000-000000000000 `
-FormInput {input1=Sales} `
-Recipients null `
-StandAloneForm false `
-State ASSIGNED `
-Ttl 1571827560
  • Convert the resource to JSON
$CreateFormInstanceRequest | ConvertTo-JSON

[Back to top]