Files
api-specs/idn/beta/schemas/forms/ConditionRule.yaml
GitHub Action Bot 1f9ccf319b Automated commit 'Merge pull request #1461 from sailpoint/devrel-1231
Devrel 1231' by github action: 6590689930
2023-10-20 17:10:31 +00:00

98 lines
4.7 KiB
YAML

properties:
sourceType:
description: |-
Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key).
INPUT ConditionRuleSourceTypeInput
ELEMENT ConditionRuleSourceTypeElement
enum:
- INPUT
- ELEMENT
example: ELEMENT
type: string
x-go-enum-desc: |-
INPUT ConditionRuleSourceTypeInput
ELEMENT ConditionRuleSourceTypeElement
x-go-name: SourceType
source:
description: |-
Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement,
the source is the name of a technical key of an element to retrieve its value.
example: department
type: string
x-go-name: Source
operator:
description: |-
ConditionRuleComparisonOperatorType value.
EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality.
NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality.
CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value.
NOT_CO ConditionRuleComparisonOperatorTypeNotContains
IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values.
NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes
EM ConditionRuleComparisonOperatorTypeEmpty
NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty
SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive.
NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith
EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive.
NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith
enum:
- EQ
- NE
- CO
- NOT_CO
- IN
- NOT_IN
- EM
- NOT_EM
- SW
- NOT_SW
- EW
- NOT_EW
example: EQ
type: string
x-go-enum-desc: |-
EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality.
NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality.
CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value.
NOT_CO ConditionRuleComparisonOperatorTypeNotContains
IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values.
NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes
EM ConditionRuleComparisonOperatorTypeEmpty
NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty
SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive.
NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith
EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive.
NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith
x-go-name: Operator
valueType:
description: |-
ConditionRuleValueType type.
STRING ConditionRuleValueTypeString This value is a static string.
STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values.
INPUT ConditionRuleValueTypeInput This value is a reference to a form input.
ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key).
LIST ConditionRuleValueTypeList
BOOLEAN ConditionRuleValueTypeBoolean
enum:
- STRING
- STRING_LIST
- INPUT
- ELEMENT
- LIST
- BOOLEAN
example: STRING
type: string
x-go-enum-desc: |-
STRING ConditionRuleValueTypeString This value is a static string.
STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values.
INPUT ConditionRuleValueTypeInput This value is a reference to a form input.
ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key).
LIST ConditionRuleValueTypeList
BOOLEAN ConditionRuleValueTypeBoolean
x-go-name: ValueType
value:
description: Based on the ValueType.
example: Engineering
x-go-name: Value
type: object
x-go-package: github.com/sailpoint/sp-forms/domain