mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
56 lines
1.7 KiB
YAML
56 lines
1.7 KiB
YAML
properties:
|
|
id:
|
|
description: Unique guid identifying the form definition.
|
|
example: 00000000-0000-0000-0000-000000000000
|
|
type: string
|
|
x-go-name: FormDefinitionID
|
|
name:
|
|
description: Name of the form definition.
|
|
example: My form
|
|
type: string
|
|
x-go-name: Name
|
|
description:
|
|
description: Form definition's description.
|
|
example: My form description
|
|
type: string
|
|
x-go-name: Description
|
|
owner:
|
|
$ref: './FormOwner.yaml'
|
|
usedBy:
|
|
description: List 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.
|
|
items:
|
|
$ref: './FormUsedBy.yaml'
|
|
type: array
|
|
x-go-name: UsedBy
|
|
formInput:
|
|
description: List of form inputs required to create a form-instance object.
|
|
items:
|
|
$ref: './FormDefinitionInput.yaml'
|
|
type: array
|
|
x-go-name: FormInput
|
|
formElements:
|
|
description: List of nested form elements.
|
|
items:
|
|
$ref: './FormElement.yaml'
|
|
type: array
|
|
x-go-name: FormElements
|
|
formConditions:
|
|
description: Conditional logic that can dynamically modify the form as the recipient is interacting with it.
|
|
items:
|
|
$ref: './FormCondition.yaml'
|
|
type: array
|
|
x-go-name: FormConditions
|
|
created:
|
|
description: Created is the date the form definition was created
|
|
example: "2023-07-12T20:14:57.74486Z"
|
|
format: date-time
|
|
type: string
|
|
x-go-name: Created
|
|
modified:
|
|
description: Modified is the last date the form definition was modified
|
|
example: "2023-07-12T20:14:57.74486Z"
|
|
format: date-time
|
|
type: string
|
|
x-go-name: Modified
|
|
type: object
|
|
x-go-package: github.com/sailpoint/sp-forms/domain |