Export form definitions by tenant.

GET {{baseUrl}}/form-definitions

No parameters required.

Request Params

Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in V3 API Standard Collection Parameters. The offset value is record-based, not page-based, and the index starts at 0. | | limit | number | | Limit

Integer specifying the maximum number of records to return in a single API call. The standard syntax described in V3 API Standard Collection Parameters. If it is not specified, a default limit is used. | | filters | string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters

Filtering is supported for the following fields and operators:

name: eq, gt, sw, in

description: eq, gt, sw, in

created: eq, gt, sw, in

modified: eq, gt, sw, in | | sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters

Sorting is supported for the following fields: name, description, created, modified |

HEADERS

RESPONSES

status: OK

{"count":1,"results":[{"id":"00000000-0000-0000-0000-000000000000","name":"My form","description":"My form description","owner":{"type":"IDENTITY","id":"00000000-0000-0000-0000-000000000000"},"usedBy":[{"type":"WORKFLOW","id":"00000000-0000-0000-0000-000000000000"},{"type":"WORKFLOW","id":"00000000-0000-0000-0000-000000000000"}],"formInput":[{"id":"00000000-0000-0000-0000-000000000000","type":"STRING","label":"input1","description":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic"},{"id":"00000000-0000-0000-0000-000000000000","type":"STRING","label":"input1","description":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic"}],"formElements":[{"id":"00000000-0000-0000-0000-000000000000","elementType":"TEXT","config":{"label":"Department"},"key":"department","validations":{}},{"id":"00000000-0000-0000-0000-000000000000","elementType":"TEXT","config":{"label":"Department"},"key":"department","validations":{}}],"formConditions":[{"ruleOperator":"AND","rules":[{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"},{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"}],"effects":[{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"incididunt in officia laborum"}},{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"occaecat"}}]},{"ruleOperator":"AND","rules":[{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"},{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"}],"effects":[{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"non eiusmod enim esse"}},{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"et c"}}]}],"created":"2023-07-12T20:14:57.74486Z","modified":"2023-07-12T20:14:57.74486Z"},{"id":"00000000-0000-0000-0000-000000000000","name":"My form","description":"My form description","owner":{"type":"IDENTITY","id":"00000000-0000-0000-0000-000000000000"},"usedBy":[{"type":"WORKFLOW","id":"00000000-0000-0000-0000-000000000000"},{"type":"WORKFLOW","id":"00000000-0000-0000-0000-000000000000"}],"formInput":[{"id":"00000000-0000-0000-0000-000000000000","type":"STRING","label":"input1","description":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic"},{"id":"00000000-0000-0000-0000-000000000000","type":"STRING","label":"input1","description":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic"}],"formElements":[{"id":"00000000-0000-0000-0000-000000000000","elementType":"TEXT","config":{"label":"Department"},"key":"department","validations":{}},{"id":"00000000-0000-0000-0000-000000000000","elementType":"TEXT","config":{"label":"Department"},"key":"department","validations":{}}],"formConditions":[{"ruleOperator":"AND","rules":[{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"},{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"}],"effects":[{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"ullamco ut"}},{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"ipsum veniam enim"}}]},{"ruleOperator":"AND","rules":[{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"},{"sourceType":"ELEMENT","source":"department","operator":"EQ","valueType":"STRING","value":"Engineering"}],"effects":[{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"aute labore aliquip consequat sint"}},{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"dolor minim"}}]}],"created":"2023-07-12T20:14:57.74486Z","modified":"2023-07-12T20:14:57.74486Z"}]}