What is the purpose of field key in Jira service management e-forms

[Sama Mohamed]

How does it serve my form? 

How does it reflect in other places?

[Joseph Chung Yin · Accepted solution]

@Sama Mohamed -

The "Field Key" (I believe it is previously named as "Question Key").  It is used for allowing you to set an identifier for the field, making it easier to find the field in the JSON data structure.  This is useful when you uses Forms REST APIs to access the data within an issue which have the Form's attachment.

Hope this helps.

Best, Joseph Chung Yin

Jira/JSM Functional Lead, Global Infrastructure Applications Team

Viasat Inc.

[Sama Mohamed]

Thank you so much your answer was helpful!

[Alex Steinlauf]

@Joseph Chung Yin is there a syntax for calling the form field via Smart value? Currently there isn't an API per: https://jira.atlassian.com/browse/JSDCLOUD-10671. When viewing the JSON of a ticket I'm not seeing any of the form fields even if there is a Field Key value in place for it.

[Joseph Chung Yin]

@Alex Steinlauf -

I don't believe you can refer to a Form field via smart value at this time.  

Best, Joseph

[RenatoLL]

Which is the link rest api url to an form?

i.e an form which was created by ticket ITCC-5
How do i get access to its form json?

[Joseph Chung Yin]

@RenatoLL -

Unfortunately, it is currently not available for the CLOUD env on Forms REST API.  It is on Atlassian's roadmap - https://www.atlassian.com/roadmap/cloud?status=future;comingSoon&selectedProduct=jiraService&search=Forms%20API

Forms REST APIs are only available for the On-prems envs and not for CLOUD yete.

Best, Joseph

[natalia.daraszkiewicz]

@Alex Steinlauf  For accessing form fields as smart values see: https://community.atlassian.com/t5/Jira-Service-Management/Use-Field-Key-in-Portal-Forms-from-Jira-Service-Management/qaq-p/1951019

[Rilwan Ahmed · Accepted solution]

Hi @Sama Mohamed ,

Can you please share me the screenshot where you are seeing the Field key. 

[Sama Mohamed]

[Sama Mohamed]

done