Skip to main content

FormDefinitionResponse

Properties

NameTypeDescriptionNotes
idstrUnique guid identifying the form definition.[optional]
namestrName of the form definition.[optional]
descriptionstrForm definition's description.[optional]
ownerFormOwner[optional]
used_by[]FormUsedByList of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it.[optional]
form_input[]FormDefinitionInputList of form inputs required to create a form-instance object.[optional]
form_elements[]FormElementList of nested form elements.[optional]
form_conditions[]FormConditionConditional logic that can dynamically modify the form as the recipient is interacting with it.[optional]
createddatetimeCreated is the date the form definition was created[optional]
modifieddatetimeModified is the last date the form definition was modified[optional]
}

Example

from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse

form_definition_response = FormDefinitionResponse(
id='00000000-0000-0000-0000-000000000000',
name='My form',
description='My form description',
owner=sailpoint.v2024.models.form_owner.FormOwner(
type = 'IDENTITY',
id = '2c9180867624cbd7017642d8c8c81f67',
name = 'Grant Smith', ),
used_by=[
sailpoint.v2024.models.form_used_by.FormUsedBy(
type = 'WORKFLOW',
id = '61940a92-5484-42bc-bc10-b9982b218cdf',
name = 'Access Request Form', )
],
form_input=[
sailpoint.v2024.models.form_definition_input.FormDefinitionInput(
id = '00000000-0000-0000-0000-000000000000',
type = 'STRING',
label = 'input1',
description = 'A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic', )
],
form_elements=[
sailpoint.v2024.models.form_element.FormElement(
id = '00000000-0000-0000-0000-000000000000',
element_type = 'TEXT',
config = {label=Department},
key = 'department',
validations = [
sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet(
validation_type = 'REQUIRED', )
], )
],
form_conditions=[
sailpoint.v2024.models.form_condition.FormCondition(
rule_operator = 'AND',
rules = [
sailpoint.v2024.models.condition_rule.ConditionRule(
source_type = 'ELEMENT',
source = 'department',
operator = 'EQ',
value_type = 'STRING',
value = 'Engineering', )
],
effects = [
sailpoint.v2024.models.condition_effect.ConditionEffect(
effect_type = 'HIDE',
config = sailpoint.v2024.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'
)

[Back to top]