REST API

Learn how to use Dynamic Forms via the REST API

You can use REST API requests to create issues with Dynamic Forms fields. There are two REST API verbs that should be sent: POST and PUT. Firstly, you need to use a Service Desk REST API to create a ticket. Next step is to update created issue with Jira REST API.

Steps

1. Create a request using POST /rest/servicedeskapi/request REST endpoint without fields managed by the Extension App.
   
   Example

   {
     "serviceDeskId": "3",
     "requestTypeId": "233",
     "requestFieldValues": {
       "summary": "Request JSD help via REST",
       "description": "I need a new mouse for my Mac"
     }
   }
   

   Rest API will return the Issue ID and Issue Key:

   {
    ...
    "issueId": "10643",
    "issueKey": "SD3-157",
    ...
   }  
   

   Request is created simultaneously with an issue.

   Info

   For more information on how to set request type when creating an issue via RestAPI click here.

2. Update newly created issue with PUT /rest/api/3/issue/{issueIdOrKey} REST endpoint to set fields managed by the Extension app.
   Example

   Sample body:

    {
      "fields": {
            "customfield_10022": "Value 1"
      }
    }  
   

   Where customfield_10022 would be an ID of the Dynamic Forms field: