forms

Get change fields applicable (visible) to current user

get/api/v1/forms/changes

Query parameters

workspace_idinteger

The workspace id

change_template_idinteger

The change template ID

change_idstring

The change display ID

view'CREATE_CHANGE_FORM' | 'CHANGE_DETAILS' | 'CHANGE_LIST' | 'UPDATE_CHANGE_ATTRIBUTES_ACTION_CONFIG_FORM' | 'CHANGE_ATTRIBUTE_PLACEHOLDERS' | 'CHANGE_TEMPLATE_ATTRIBUTES_SETTINGS'
status_valuestring
event_type'CREATE' | 'VIEW_OR_UPDATE' | 'VIEW' | 'UPDATE' | 'CLOSE'
requested_forinteger

User id the change is being raised for. When this equals the calling user, requestor access settings are enforced instead of agent settings.

asset_idinteger

Asset to preselect on the Linked assets field, for forms opened from an asset context. When set and resolvable, that field is returned with default_selection set to this asset and can_fill / can_edit false, so it renders read-only. The frontend must still submit the value. An asset id that is unknown, deleted, or not visible to the caller is ignored: the form is returned normally with no preselection rather than an error.

Headers

X-Api-Keystring required
X-Workspace-Idstring

Response

Successful response

FormsGetapiV1FormsChangesResponse200 required

Empty response body

Changes