JIRA DC Rest API - Incomplete Documentation for Get Workflow Property

Hi there

The latest API reference includes an endpoint for gaining access to workflow properties: https://docs.atlassian.com/software/jira/docs/api/REST/8.19.1/#workflow-getProperties

The endpoint is:

    /rest/workflow/{id}/properties

The issue is that nowhere in the documentation does it explain what {id} is.

I have successfully used my admin credentials to call /rest/api/2/workflow but as per the schema documented there is no ‘id’ property for a workflow:

    {
        "name": "jira",
        "description": "The default Jira workflow",
        "steps": 5,
        "default": true
    },
    {
        "name": "classic default workflow",
        "description": "The classic JIRA default workflow",
        "steps": 5,
        "default": false
    }

Workflows appear to be referenced only by their name.

According to the possible query properties which include “workflowName” it makes sense that {id} would be the workflow step number, however calling the first step results in a 404:

curl --location --request GET 'http://jira.XXXXXXXXXXXXXX.com/rest/api/2/workflow/1/properties?workflowName=classic default workflow&workflowMode=draft'

=>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<status>
    <status-code>404</status-code>
    <message>null for uri: http://jira.XXXXXXXXXXX.com/rest/api/2/workflow/1/properties?workflowName=classic%20default%20workflow&amp;workflowMode=draft</message>
</status>

Can anyone point me to an example of calling the DC Rest API for this endpoint and / or explain what the {id} parameter is, please?

I’m tearing my hear out. :disappointed_relieved:

Thank you in advance,

Paul

You have to be freaking kidding me… Seriously?

The documentation clearly states the endpoint is:

/rest/workflow/{id}/properties

I was close when I was guessing that {id} might have been the step number. It’s not. It specifies the ‘transition id’ AND the actual endpoint is in fact:

/rest/workflow/transitions/{id}/properties

The ‘transitions’ part of the part being rather seminal, I would have thought. :man_facepalming: