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

Response

200

Successful response