Skip to main content

CreateFormInstanceRequest

Properties

NameTypeDescriptionNotes
created_byFormInstanceCreatedBy[required]
expirestrExpire is required[required]
form_definition_idstrFormDefinitionID is the id of the form definition that created this form[required]
form_inputmap[string]objectFormInput is an object of form input labels to value[optional]
recipients[]FormInstanceRecipientRecipients is required[required]
stand_alone_formboolStandAloneForm 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]
ttlintTTL 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]
}

Example

from sailpoint.beta.models.create_form_instance_request import CreateFormInstanceRequest

create_form_instance_request = CreateFormInstanceRequest(
created_by=sailpoint.beta.models.form_instance_created_by.FormInstanceCreatedBy(
id = '00000000-0000-0000-0000-000000000000',
type = 'WORKFLOW_EXECUTION', ),
expire='2023-08-12T20:14:57.74486Z',
form_definition_id='00000000-0000-0000-0000-000000000000',
form_input={input1=Sales},
recipients=[
sailpoint.beta.models.form_instance_recipient.FormInstanceRecipient(
id = '00000000-0000-0000-0000-000000000000',
type = 'IDENTITY', )
],
stand_alone_form=False,
state='ASSIGNED',
ttl=1571827560
)

[Back to top]