Qodex.ai

Patch a form instance.

PATCH {{baseUrl}}/form-instances/:formInstanceID

Parameter {formInstanceID} should match a form instance ID.

Request Body

{"0"=>{"op"=>"replace", "path"=>"/state", "value"=>"SUBMITTED"}, "1"=>{"op"=>"replace", "path"=>"/formData", "value"=>{"a-key-1"=>"a-value-1", "a-key-2"=>true, "a-key-3"=>1}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"created":"2023-07-12T20:14:57.74486Z","createdBy":{"id":"00000000-0000-0000-0000-000000000000","type":"WORKFLOW_EXECUTION"},"expire":"2023-08-12T20:14:57.74486Z","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":"commodo in Ex"}},{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"non eiusmod eu"}}]},{"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":"esse Lorem elit adipisicing"}},{"effectType":"HIDE","config":{"defaultValueLabel":"Access to Remove","element":"ea veniam"}}]}],"formData":{"department":"Engineering"},"formDefinitionId":"00000000-0000-0000-0000-000000000000","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":{}}],"formErrors":[{"key":"department","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"This is an error"},{"locale":"en-US","localeOrigin":"DEFAULT","text":"This is an error"}],"value":"Engineering"},{"key":"department","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"This is an error"},{"locale":"en-US","localeOrigin":"DEFAULT","text":"This is an error"}],"value":"Engineering"}],"formInput":{"input1":"Sales"},"id":"00000000-0000-0000-0000-000000000000","modified":"2023-07-12T20:14:57.74486Z","recipients":[{"id":"00000000-0000-0000-0000-000000000000","type":"IDENTITY"},{"id":"00000000-0000-0000-0000-000000000000","type":"IDENTITY"}],"standAloneForm":false,"standAloneFormUrl":"https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000","state":"ASSIGNED"}