Forms

Get list of options for the field identified by reference_key

GET https://{tenant}.atomicwork.com/api/v1/forms/{entity_type}/{reference_key}/options

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Path Parameters

entity_typepathenum (string)required

Allowed valuesREQUESTSERVICE_REQUESTQUESTION_REQUESTINCIDENT_REQUESTINCIDENTPROBLEM_REQUESTPROBLEMUSERSERVICE_ITEMCUSTOM_FORMSURVEYASSETCHANGECHANGE_TEMPLATECUSTOM_OBJECTNO_OBJECTEXTERNAL_WEBHOOK

reference_keypathstringrequired

The reference key of a dropdown, multi dropdown, nested dropdown field

Query Parameters

workspace_idqueryinteger

The workspace id

request_sub_typequeryenum (string)

Allowed valuesREQUESTINCIDENTSERVICE_REQUESTPROBLEMCHANGEMAJOR_INCIDENT

request_idquerystring

The request display ID

entity_idqueryinteger

The service item id in case entity_type is SERVICE_ITEM

parent_option_idqueryinteger

search_keyquerystring

selected_option_idsqueryarray of integer

pagequeryintegerrequired

per_pagequeryinteger

viewqueryenum (string)

Allowed valuesHOMEWORKFLOWJOURNEYLISTINSIGHTSCUSTOM_SLAASSET_LISTRELATIONSHIP_ATTRIBUTESCHEDULE_WORKFLOWSEARCHNOTIFICATIONSASSET_RELATIONSHIPSUSER_SEGMENTSMULTI_SOURCE_SYNCMAJOR_INCIDENT_CREATEAPPROVERS

is_flattened_nested_field_requiredqueryboolean

include_anyqueryboolean

is_value_required_as_idqueryboolean

field_entity_sourcequeryenum (string)

Allowed valuesJSMSERVICE_NOWINTERNAL

external_field_typequeryenum (string)

Allowed valuesUSERPROFORMA

Response

200

Successful response