Forms

Get change fields applicable (visible) to current user

GET https://{tenant}.atomicwork.com/api/v1/forms/changes

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Query Parameters

workspace_idqueryinteger

The workspace id

change_template_idqueryinteger

The change template ID

change_idquerystring

The change display ID

viewqueryenum (string)

Allowed valuesCREATE_CHANGE_FORMCHANGE_DETAILSCHANGE_LISTUPDATE_CHANGE_ATTRIBUTES_ACTION_CONFIG_FORMCHANGE_ATTRIBUTE_PLACEHOLDERSCHANGE_TEMPLATE_ATTRIBUTES_SETTINGS

status_valuequerystring

event_typequeryenum (string)

Allowed valuesCREATEVIEW_OR_UPDATEVIEWUPDATECLOSE

requested_forqueryinteger

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

asset_idqueryinteger

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.

Response

200

Successful response