Skip to navigation
Atomicwork Public APIForms

Get request fields applicable (visible) to current user

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Headers

X-Workspace-IdstringOptional

Query parameters

request_form_typeenumOptional
Allowed values:
request_typeenumOptional
supported_objectsenumOptional

The supported object type. Takes precedence over request_type if both are provided.

Allowed values:
workspace_idlongOptional
The workspace id
request_idstringOptional
The request display ID
service_item_idslist of longsOptional
The service item ids if service request is being created
catalog_item_idslist of longsOptional

The catalogue item fields if catalogue request is being created, we will depreciate(service_item_ids) this soon.

channel_typeenumOptional
Allowed values:
channel_idstringOptional>=3 characters
viewenumOptional
status_valuestringOptional
requested_forlongOptional
User id the request is being raised for. When this equals the calling user, requestor access settings are enforced instead of agent settings.
assigned_tolongOptional

User id the request 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. Has no effect on request types whose form has no Linked assets field (e.g. service requests).

Response

Successful response