Get list of options for the field identified by reference_key | Atomicwork

curl -G https://{tenant}.atomicwork.com/api/v1/forms/REQUEST/reference_key/options \
     -H "X-Workspace-Id: 987654321" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d request_sub_type=SERVICE_REQUEST \
     -d page=1 \
     -d view=HOME \
     -d field_entity_source=JSM \
     -d external_field_type=USER \
     -d workspace_id=987654321 \
     -d request_id=REQ-20240615-00123 \
     -d entity_id=456789 \
     -d parent_option_id=12 \
     -d search_key=high \
     -d selected_option_ids=1 \
     -d selected_option_ids=3 \
     -d selected_option_ids=5 \
     -d per_page=50 \
     -d is_flattened_nested_field_required=true \
     -d include_any=false \
     -d is_value_required_as_id=true

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

entity_typeenumRequired

reference_keystringRequired1-255 characters

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

Query parameters

workspace_idlongOptional

The workspace id

request_sub_typeenumOptional

request_idstringOptional

The request display ID

entity_idlongOptional

The service item id in case entity_type is SERVICE_ITEM

parent_option_idlongOptional>=1

search_keystringOptional>=1 character

selected_option_idslist of longsOptional

pageintegerRequired>=1Defaults to 1

per_pageintegerOptional1-1000Defaults to 25

viewenumOptional

is_flattened_nested_field_requiredbooleanOptionalDefaults to false

include_anybooleanOptionalDefaults to false

is_value_required_as_idbooleanOptionalDefaults to false

field_entity_sourceenumOptional

Allowed values:

external_field_typeenumOptional

JSM (Jira Service Management) field type identifier

Allowed values:

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response