ArtifactDefinition schema
The artifact document type, validated against the published JSON schema.
Example
artifact.json
{
"id": "request-form",
"items": [
{
"type": "TEXT",
"id": "summary",
"label": "Request summary",
"required": true
}
]
}
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | yes | Unique artifact identifier. Must match the filename stem. |
items | array of ArtifactItem | yes | — |
Definitions
ArtifactItem
No properties.
TextItem
| Property | Type | Required | Description |
|---|---|---|---|
type | const TEXT | yes | — |
id | string | yes | — |
label | string | yes | — |
required | boolean | no | — |
hint | string | no | — |
TextAreaItem
| Property | Type | Required | Description |
|---|---|---|---|
type | const TEXT_AREA | yes | — |
id | string | yes | — |
label | string | yes | — |
required | boolean | no | — |
hint | string | no | — |
SingleChoiceItem
| Property | Type | Required | Description |
|---|---|---|---|
type | const SINGLE_CHOICE | yes | — |
id | string | yes | — |
label | string | yes | — |
required | boolean | no | — |
options | array of string | yes | — |
MultiChoiceItem
| Property | Type | Required | Description |
|---|---|---|---|
type | const MULTI_CHOICE | yes | — |
id | string | yes | — |
label | string | yes | — |
required | boolean | no | — |
options | array of string | yes | — |
BooleanItem
| Property | Type | Required | Description |
|---|---|---|---|
type | const BOOLEAN | yes | — |
id | string | yes | — |
label | string | yes | — |
required | boolean | no | — |
NumberItem
| Property | Type | Required | Description |
|---|---|---|---|
type | const NUMBER | yes | — |
id | string | yes | — |
label | string | yes | — |
required | boolean | no | — |
DateItem
| Property | Type | Required | Description |
|---|---|---|---|
type | const DATE | yes | — |
id | string | yes | — |
label | string | yes | — |
required | boolean | no | — |