Get Form By ID | Moveworks

curl http://localhost:5000/myinstance1/forms/formId \
     -H "Authorization: Bearer <token>"

{
  "id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
  "domain": "IT",
  "title": "Local Admin Access",
  "url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
  "last_updated_at": "2022-10-20T07:00:00Z",
  "image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
  "description": "Lorem Ipsum",
  "short_description": "Lorem Ipsum",
  "fields": [
    {
      "name": "permissions",
      "label": "Which permissions do you need?",
      "type": "LABEL",
      "placeholder": "Enter text here.",
      "help": "If you need help figuring out which access you need, ask your bot.",
      "default_to_current_user": false,
      "options": [
        {
          "label": "System Administrator",
          "value": "system_administrator"
        }
      ],
      "required": false,
      "visible": true
    }
  ],
  "dynamic_field_rules": [
    {
      "name": "Hide 2FA if write access not needed",
      "conditions": [
        {
          "field_name": "2fa_device",
          "operator": "EQUALS",
          "value": true
        }
      ],
      "actions": [
        {
          "field_name": "read_or_write",
          "visible": false,
          "required": true
        }
      ],
      "logical": "AND"
    }
  ]
}

Form with the requested ID should be returned from this API. Anticipated load – Moveworks may call this endpoint a few times every 24 hours. This API is primarily for sanity checks and debugging. Since ingestion happens once every 24 hours, we might want to verify if form submission failures are due to deviations between the local and remote versions.

curl http://localhost:5000/myinstance1/forms/formId \
     -H "Authorization: Bearer <token>"

{
  "id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
  "domain": "IT",
  "title": "Local Admin Access",
  "url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
  "last_updated_at": "2022-10-20T07:00:00Z",
  "image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
  "description": "Lorem Ipsum",
  "short_description": "Lorem Ipsum",
  "fields": [
    {
      "name": "permissions",
      "label": "Which permissions do you need?",
      "type": "LABEL",
      "placeholder": "Enter text here.",
      "help": "If you need help figuring out which access you need, ask your bot.",
      "default_to_current_user": false,
      "options": [
        {
          "label": "System Administrator",
          "value": "system_administrator"
        }
      ],
      "required": false,
      "visible": true
    }
  ],
  "dynamic_field_rules": [
    {
      "name": "Hide 2FA if write access not needed",
      "conditions": [
        {
          "field_name": "2fa_device",
          "operator": "EQUALS",
          "value": true
        }
      ],
      "actions": [
        {
          "field_name": "read_or_write",
          "visible": false,
          "required": true
        }
      ],
      "logical": "AND"
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KEYstring

API Key authentication via header

Path parameters

formIdstringRequired

ID of form to return

Response headers

X-RateLimit-Limitinteger

The maximum number of requests you're permitted to make per minute.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-RateLimit-Resetstring

The remaining window before the rate limit FULLY resets in UTC epoch seconds.

Response

A single form

idstring

Stable unique identifier for the form.

domainenum

Specifies the domain the form belongs to.

Allowed values:

titlestring

Title of the form. This will be displayed to the end user.

urlstring

Self-service portal URL where the user can fill out the form if in-bot form filling is not supported.

last_updated_atstring

Last updated date as a ISO-8601 UTC timestamp (e.g., 2021-10-20T17:28:52Z)

image_urlstring

Publically accessible image URL for the form

descriptionstring1-2000 characters

A long description of the form’s purpose. This is used in our form search machine learning, and is also displayed to the end user.

short_descriptionstring1-140 characters

A short description of the form’s purpose. This is used in our form search machine learning, and is also displayed to the end user.

fieldslist of objects

A list of fields that make up this form.

dynamic_field_ruleslist of objects

A list of rules that specify dynamic form field behavior based on user response to other fields.

$	curl http://localhost:5000/myinstance1/forms/formId \
>	-H "Authorization: Bearer <token>"

1	{
2	"id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
3	"domain": "IT",
4	"title": "Local Admin Access",
5	"url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
6	"last_updated_at": "2022-10-20T07:00:00Z",
7	"image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
8	"description": "Lorem Ipsum",
9	"short_description": "Lorem Ipsum",
10	"fields": [
11	{
12	"name": "permissions",
13	"label": "Which permissions do you need?",
14	"type": "LABEL",
15	"placeholder": "Enter text here.",
16	"help": "If you need help figuring out which access you need, ask your bot.",
17	"default_to_current_user": false,
18	"options": [
19	{
20	"label": "System Administrator",
21	"value": "system_administrator"
22	}
23	],
24	"required": false,
25	"visible": true
26	}
27	],
28	"dynamic_field_rules": [
29	{
30	"name": "Hide 2FA if write access not needed",
31	"conditions": [
32	{
33	"field_name": "2fa_device",
34	"operator": "EQUALS",
35	"value": true
36	}
37	],
38	"actions": [
39	{
40	"field_name": "read_or_write",
41	"visible": false,
42	"required": true
43	}
44	],
45	"logical": "AND"
46	}
47	]
48	}