Jira Align REST API: Process Step not auto-set for Epics/Capabilities when only state is provided

XMLWordPrintable

    • Type: Bug
    • Resolution: Unresolved
    • Priority: Low
    • 11.23.0
    • Affects Version/s: 11.14.1
    • Component/s: Capabilities

      Issue Summary

      When you create an Epic or a Capability via the Jira Align REST API in a program where Process Steps are configured for Epics and Capabilities and State-to-Step mapping is enabled, the Process Step is not set automatically if you specify only the state in the POST request
      In the response body, you will notice that the "processStepId" is null.
      This does not occur when creating a Feature via the REST API with a similar setup: the process step is correctly inferred when only the state is provided in the POST request.

      Steps to Reproduce

      Pre-requisite:
      Ensure you configure a Process Step Flow for the levels: Epic and capability, with the 'Map to Step' option enabled, and assign the appropriate process step to state mapping
      (for example, '2-In Progress' mapped to Process Step 'WORK_IN_PROGRESS').

      1. Create a capability for a specific program using, for example, a POST request to the https://<site-url>/rest/align/api/2/capabilities/ endpoint.
      {
          "title": "CapabilityAPI",
          "description": "Capability created from API",
          "primaryProgramId": 156,
          "state": 2,
          "parentId": 1391,
          "type": 1,
          "releaseIds": [
              172
          ]
         }
      

       

      The same applies for Epics using the endpoints https://<site-url>/rest/align/api/2/epics/ endpoint

      Expected Results

      The capability is created with the correct state '2-In Progress' and the process step is set to the appropriate value (i.e.'WORK_IN_PROGRESS').
      You can see in the response body that "processStepId" is set accordingly.

      {
          "id": 1420,
          "title": "CapabilityAPI",
          "createDate": "2025-08-07T14:14:45.197Z",
          "createdBy": "1212",
          "ownerId": "1212",
          "description": "Capability created from API",
          "primaryProgramId": 156,
          "tags": null,
          "state": 2,
          [...]
          "processStepId": 248,
          [...]
           "releaseIds": [
              172
          ],
          [...]
      }
      

      Actual Results

      The Capability is created with the correct State '2-In Progress' but without setting the Process step information
      You’ll notice in the response body that "processStepId" is null.

      {
          "id": 1420,
          "title": "CapabilityAPI",
          "createDate": "2025-08-07T14:14:45.197Z",
          "createdBy": "1212",
          "ownerId": "1212",
          "description": "Capability created from API",
          "primaryProgramId": 156,
          "tags": null,
          "state": 2,
          [...]
          "processStepId": null,
          [...]
           "releaseIds": [
              172
          ],
          [...]
      }
      

      Workaround

      Include the 'processStepId' directly in your POST request.
      Here’s an example:

      {
          "title": "CapabilityAPI",
          "description": "Capability created from API",
          "primaryProgramId": <programId>,
          "state": 2,
          "parentId": <parentId>,
          "type": 1,
          "releaseIds": [
              <released>
          ],
          "processStepId":<process_step_id>
      }
      

              Assignee:
              Yannick Genin
              Reporter:
              Francois Panaget (Inactive)
              Votes:
              3 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated: