Forms

Get request fields applicable (visible) to current user

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

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Query Parameters

request_form_typequeryenum (string)

Allowed valuesREQUESTQUESTION_REQUESTINCIDENT_REQUESTSERVICE_REQUESTPROBLEM_REQUEST

request_typequeryenum (string)

Allowed valuesREQUESTINCIDENTSERVICE_REQUESTPROBLEMCHANGEMAJOR_INCIDENT

supported_objectsqueryenum (string)

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

Allowed valuesREQUESTSERVICE_REQUESTINCIDENTPROBLEMCHANGE

workspace_idqueryinteger

The workspace id

request_idquerystring

The request display ID

service_item_idsqueryarray of integer

The service item ids if service request is being created

catalog_item_idsqueryarray of integer

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

channel_typequeryenum (string)

Allowed valuesSLACKMS_TEAMSEMAILATOMICINBOXUNIVERSAL_AGENT

channel_idquerystring

viewqueryenum (string)

Allowed valuesHOMEWORKFLOWJOURNEYLISTINSIGHTSCUSTOM_SLAASSET_LISTRELATIONSHIP_ATTRIBUTESCHEDULE_WORKFLOWSEARCHNOTIFICATIONSASSET_RELATIONSHIPSUSER_SEGMENTSMULTI_SOURCE_SYNCMAJOR_INCIDENT_CREATEAPPROVERS

status_valuequerystring

requested_forqueryinteger

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

Response

200

Successful response