import-form-definitions | SailPoint Developer Community

Import form definitions from export.

application/json

Request Body array

Body is the request payload to import form definitions

object object
created date-time
Created is the date the form definition was created
description string
Description is the form definition description
formConditions object[]
FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form
effects object[]
Effects is a list of effects
config object
Config is a arbitrary map that holds a configuration based on EffectType
effectType string
Possible values: [HIDE, SHOW, DISABLE, ENABLE, REQUIRE, OPTIONAL, SUBMIT_MESSAGE, SUBMIT_NOTIFICATION, SET_DEFAULT_VALUE]
EffectType is the type of effect to perform when the conditions are evaluated for this logic block HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations SHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations DISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations ENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose
ruleOperator string
Possible values: [AND, OR]
RuleOperator is a ConditionRuleLogicalOperatorType value AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr
rules object[]
Rules is a list of rules
operator string
Possible values: [EQ, NE, CO, NOT_CO, IN, NOT_IN, EM, NOT_EM, SW, NOT_SW, EW, NOT_EW]
Operator is a ConditionRuleComparisonOperatorType value EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality NE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality CO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith
source string
Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement then source is the name of a technical key of an element to retrieve its value
sourceType string
Possible values: [INPUT, ELEMENT]
SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key) INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement
value
Value is the value based on the ValueType
valueType string
Possible values: [STRING, STRING_LIST, INPUT, ELEMENT, LIST, BOOLEAN]
ValueType is a ConditionRuleValueType type STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string STRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values INPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by ELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key) LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean
formElements object[]
FormElements is a list of nested form elements
config object
Config is a config object
elementType string
Possible values: [TEXT, TOGGLE, TEXTAREA, HIDDEN, PHONE, EMAIL, SELECT, DATE, SECTION, COLUMNS]
ElementType is a FormElementType value TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMNS FormElementTypeColumns
id string
ID is a form element identifier
key string
Key is the technical key
validations object
FormElementValidationsSet is a set of FormElementValidation items
formInput object[]
FormInput is a list of form inputs that are required when creating a form-instance object
description string
Description is the description for this form input value
id string
ID is a unique identifier
label string
Label is the name for this form input value
type string
Possible values: [STRING]
Type is a FormDefinitionInputType value STRING FormDefinitionInputTypeString
id string
FormDefinitionID is a unique guid identifying this form definition
modified date-time
Modified is the last date the form definition was modified
name string
Name is the form definition name
owner object
id string
ID is a unique identifier
type string
Possible values: [IDENTITY]
Type is a FormOwnerType value IDENTITY FormOwnerTypeIdentity
usedBy object[]
UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used
id string
ID is a unique identifier
type string
Possible values: [WORKFLOW, SOURCE]
Type is a FormUsedByType value WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource
self string
version int8

Responses

Returns statuses of those form definition objects imported

application/json

Schema
Example (from schema)

Schema

errors object[]
detail object
property name* object
key string
text string
importedObjects object[]
object object
created date-time
Created is the date the form definition was created
description string
Description is the form definition description
formConditions object[]
FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form
effects object[]
Effects is a list of effects
config object
Config is a arbitrary map that holds a configuration based on EffectType
effectType string
Possible values: [HIDE, SHOW, DISABLE, ENABLE, REQUIRE, OPTIONAL, SUBMIT_MESSAGE, SUBMIT_NOTIFICATION, SET_DEFAULT_VALUE]
EffectType is the type of effect to perform when the conditions are evaluated for this logic block HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations SHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations DISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations ENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose
ruleOperator string
Possible values: [AND, OR]
RuleOperator is a ConditionRuleLogicalOperatorType value AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr
rules object[]
Rules is a list of rules
operator string
Possible values: [EQ, NE, CO, NOT_CO, IN, NOT_IN, EM, NOT_EM, SW, NOT_SW, EW, NOT_EW]
Operator is a ConditionRuleComparisonOperatorType value EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality NE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality CO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith
source string
Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement then source is the name of a technical key of an element to retrieve its value
sourceType string
Possible values: [INPUT, ELEMENT]
SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key) INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement
value
Value is the value based on the ValueType
valueType string
Possible values: [STRING, STRING_LIST, INPUT, ELEMENT, LIST, BOOLEAN]
ValueType is a ConditionRuleValueType type STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string STRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values INPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by ELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key) LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean
formElements object[]
FormElements is a list of nested form elements
config object
Config is a config object
elementType string
Possible values: [TEXT, TOGGLE, TEXTAREA, HIDDEN, PHONE, EMAIL, SELECT, DATE, SECTION, COLUMNS]
ElementType is a FormElementType value TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMNS FormElementTypeColumns
id string
ID is a form element identifier
key string
Key is the technical key
validations object
FormElementValidationsSet is a set of FormElementValidation items
formInput object[]
FormInput is a list of form inputs that are required when creating a form-instance object
description string
Description is the description for this form input value
id string
ID is a unique identifier
label string
Label is the name for this form input value
type string
Possible values: [STRING]
Type is a FormDefinitionInputType value STRING FormDefinitionInputTypeString
id string
FormDefinitionID is a unique guid identifying this form definition
modified date-time
Modified is the last date the form definition was modified
name string
Name is the form definition name
owner object
id string
ID is a unique identifier
type string
Possible values: [IDENTITY]
Type is a FormOwnerType value IDENTITY FormOwnerTypeIdentity
usedBy object[]
UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used
id string
ID is a unique identifier
type string
Possible values: [WORKFLOW, SOURCE]
Type is a FormUsedByType value WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource
self string
version int8
infos object[]
detail object
property name* object
key string
text string
warnings object[]
detail object
property name* object
key string
text string

{
  "errors": [
    {
      "detail": {},
      "key": "string",
      "text": "string"
    }
  ],
  "importedObjects": [
    {
      "object": {
        "created": "2023-07-12T20:14:57.74486Z",
        "description": "My form description",
        "formConditions": [
          {
            "effects": [
              {
                "config": {},
                "effectType": "HIDE"
              }
            ],
            "ruleOperator": "AND",
            "rules": [
              {
                "operator": "EQ",
                "source": "department",
                "sourceType": "ELEMENT",
                "value": "Engineering",
                "valueType": "STRING"
              }
            ]
          }
        ],
        "formElements": [
          {
            "config": {
              "label": "Department"
            },
            "elementType": "TEXT",
            "id": "00000000-0000-0000-0000-000000000000",
            "key": "department",
            "validations": [
              {
                "validationType": "REQUIRED"
              }
            ]
          }
        ],
        "formInput": [
          {
            "description": "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic",
            "id": "00000000-0000-0000-0000-000000000000",
            "label": "input1",
            "type": "STRING"
          }
        ],
        "id": "00000000-0000-0000-0000-000000000000",
        "modified": "2023-07-12T20:14:57.74486Z",
        "name": "My form",
        "owner": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "IDENTITY"
        },
        "usedBy": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "WORKFLOW"
          }
        ]
      },
      "self": "string",
      "version": 0
    }
  ],
  "infos": [
    {
      "detail": {},
      "key": "string",
      "text": "string"
    }
  ],
  "warnings": [
    {
      "detail": {},
      "key": "string",
      "text": "string"
    }
  ]
}

An error with the request occurred

application/json

Schema
Example (from schema)

Schema

detailCode string
messages object[]
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
statusCode int64
trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

An error with the authorization occurred

application/json

Schema
Example (from schema)

Schema

detailCode string
messages object[]
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
statusCode int64
trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

An error with the user permissions occurred

application/json

Schema
Example (from schema)

Schema

detailCode string
messages object[]
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
statusCode int64
trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

Too many requests

application/json

Schema
Example (from schema)

Schema

detailCode string
DetailCode is the text of the status code returned
messages object[]
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
trackingId string
TrackingID is the request tracking unique identifier

{
  "detailCode": "Internal Server Error",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "trackingId": "9cd03ef80e6a425eb6b11bdbb057cdb4"
}

An internal server error occurred

application/json

Schema
Example (from schema)

Schema

detailCode string
messages object[]
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
statusCode int64
trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

Import form definitions from export.​

Import form definitions from export.