Skip to navigation
Atomicwork Public APIForms

Get change fields applicable (visible) to current user

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Headers

X-Workspace-IdstringOptional

Query parameters

workspace_idlongOptional
The workspace id
change_template_idlongOptional
The change template ID
change_idstringOptional
The change display ID
viewenumOptional
status_valuestringOptional
event_typeenumOptional
Allowed values:
requested_forlongOptional
User id the change is being raised for. When this equals the calling user, requestor access settings are enforced instead of agent settings.
assigned_tolongOptional

User id the change is being assigned to. Create-form fallback for the AR1 rule: when this equals the calling user, the caller is acting as an agent, so self-raise is suppressed and agent settings are served. On a loaded entity the persisted assignee takes precedence.

asset_idlongOptional

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

Successful response