Skip to navigation

Rich Text Forms

View as Markdown

tool.ticket.rich-text-forms

Rich ticket-filing forms (MWForm). form_id must be unique and not “1”/“2”/“3” (reserved built-in DL forms).

  • Endpoint: /tool/ticket/rich-text-forms | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/ticket/rich-text-formsList rich text forms
POST/tool/ticket/rich-text-formsCreate rich text form
GET/tool/ticket/rich-text-forms/{id}Get rich text form
PATCH/tool/ticket/rich-text-forms/{id}Update rich text form

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
domainenum✅The business domain the form belongs to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN. One of: IT_DOMAIN, HR_DOMAIN, FACILITY_DOMAIN, FINANCE_DOMAIN, LEGAL_DOMAIN, OTHER_DOMAIN, PAYROLL_DOMAIN, PROCUREMENT_DOMAIN, … (12 values).
form_idstring✅Your unique identifier for the form. Must not duplicate another form’s ID and cannot be changed after creation.
titlestring✅The title of the form shown to users.
short_descriptionstring✅A short description of the form.
descriptionstringAn optional longer description of the form. Up to 1000 characters.
fieldsarray<TicketFormFieldSettings>The input fields shown on the form.
update_rulesarray<TicketFormUpdateRuleSettings>Rules that dynamically change field behavior on the form. Rules run in the order defined, so a later rule overrides an earlier one for the same field.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"domain": "IT_DOMAIN",
"form_id": "<id>",
"title": "Example title",
"short_description": "What this is for",
"description": "What this is for",
"fields": [
{
"label": "<string>",
"field_name": "example-name",
"type": "TEXT",
"description": "What this is for",
"required": true,
"read_only": true,
"auto_population_setting": "IGNORE",
"field_options": [
{
"label": "<string>",
"value": "<string>",
"mark_as_default": true
}
],
"default_value": {
"label": "<string>",
"value": "<string>"
}
}
],
"update_rules": [
{
"field_update_condition": {
"condition_expression": "<string>",
"condition_expression_policy_field_ids": [
"field_example"
]
},
"field_updates_when_true": [
{
"policy_field_id": "example_name",
"field_actions": [
{
"property_required_enabled": true
}
]
}
],
"field_updates_when_false": [
{
"policy_field_id": "example_name",
"field_actions": [
{
"property_required_enabled": true
}
]
}
],
"rule_description": "What this is for"
}
],
"version": {
"change_description": "Create rich text form"
}
}