Skip to main content

FormInstanceResponse

Properties

NameTypeDescriptionNotes
idstrUnique guid identifying this form instance[optional]
expirestrExpire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record[optional]
stateEnum [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ]State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled[optional]
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]
stand_alone_form_urlstrStandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI[optional]
created_byFormInstanceCreatedBy[optional]
form_definition_idstrFormDefinitionID is the id of the form definition that created this form[optional]
form_inputmap[string]objectFormInput is an object of form input labels to value[optional]
form_elements[]FormElementFormElements is the configuration of the form, this would be a repeat of the fields from the form-config[optional]
form_datamap[string]objectFormData is the data provided by the form on submit. The data is in a key -> value map[optional]
form_errors[]FormErrorFormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors[optional]
form_conditions[]FormConditionFormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form[optional]
createddatetimeCreated is the date the form instance was assigned[optional]
modifieddatetimeModified is the last date the form instance was modified[optional]
recipients[]FormInstanceRecipientRecipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it[optional]
}

Example

from sailpoint.beta.models.form_instance_response import FormInstanceResponse

form_instance_response = FormInstanceResponse(
id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2',
expire='2023-08-12T20:14:57.74486Z',
state='ASSIGNED',
stand_alone_form=False,
stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000',
created_by=sailpoint.beta.models.form_instance_created_by.FormInstanceCreatedBy(
id = '00000000-0000-0000-0000-000000000000',
type = 'WORKFLOW_EXECUTION', ),
form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331',
form_input={input1=Sales},
form_elements=[
sailpoint.beta.models.form_element.FormElement(
id = '00000000-0000-0000-0000-000000000000',
element_type = 'TEXT',
config = {label=Department},
key = 'department',
validations = [
sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet(
validation_type = 'REQUIRED', )
], )
],
form_data={department=Engineering},
form_errors=[
sailpoint.beta.models.form_error.FormError(
key = 'department',
messages = [
sailpoint.beta.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'This is an error', )
],
value = Engineering, )
],
form_conditions=[
sailpoint.beta.models.form_condition.FormCondition(
rule_operator = 'AND',
rules = [
sailpoint.beta.models.condition_rule.ConditionRule(
source_type = 'ELEMENT',
source = 'department',
operator = 'EQ',
value_type = 'STRING',
value = 'Engineering', )
],
effects = [
sailpoint.beta.models.condition_effect.ConditionEffect(
effect_type = 'HIDE',
config = sailpoint.beta.models.condition_effect_config.ConditionEffect_config(
default_value_label = 'Access to Remove',
element = '8110662963316867', ), )
], )
],
created='2023-07-12T20:14:57.744860Z',
modified='2023-07-12T20:14:57.744860Z',
recipients=[
sailpoint.beta.models.form_instance_recipient.FormInstanceRecipient(
id = '00000000-0000-0000-0000-000000000000',
type = 'IDENTITY', )
]
)

[Back to top]