Sample code for 30+ languages & platforms
CkPython Requires Chilkat v11.0.0+

Jira Cloud: Change an Issue Status

See more Jira Examples

List the workflow transitions currently available to an issue and execute the transition selected by name. A transition is an action, not merely a destination status: use the name returned by Jira, and do not assume the ID or name is the same in every project.

The expanded transition metadata identifies fields associated with transition screens. This basic example refuses a transition with required fields so it cannot silently omit them. Adapt the POST body with the required fields before using such a transition. Workflow conditions and validators can still reject a request, and the available transitions can change between GET and POST.

The code uses an Atlassian account email and an API token without scopes with the site URL. For a scoped API token, keep Basic authentication and change baseUrl to https://api.atlassian.com/ex/jira/YOUR_CLOUD_ID. For OAuth2, use that gateway URL, omit Login/Password/BasicAuth, and set http.AuthToken to the access token. See API token authentication and OAuth2 authorization. The account must have permission for the operation; OAuth scopes do not grant additional Jira permissions.

Targets Jira Cloud. Jira Data Center has a separate REST API and may require different paths, authentication, or payloads.

Atlassian REST API documentation

Chilkat CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

http = chilkat.CkHttp()
http.put_RequireSslCertVerify(True)
http.put_BasicAuth(True)
#  Read these credentials from private application configuration.
http.put_Login("YOUR_ATLASSIAN_EMAIL")
http.put_Password("YOUR_API_TOKEN")
baseUrl = "https://your-domain.atlassian.net"
http.put_Accept("application/json")
url = chilkat.CkStringBuilder()
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
issueKey = "PROJECT-123"
http.SetUrlVar("issueKey",issueKey)
transitionName = "Start Progress"
transitionId = ""
matches = 0
needsFields = False
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/{$issueKey}/transitions?expand=transitions.fields")
success = http.HttpNoBody("GET",url.getAsString(),resp)
if (resp.get_StatusCode() == 0):
    print("No HTTP response was received. Check connectivity and TLS settings.")
    sys.exit()

if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    print("Request failed. HTTP " + str(resp.get_StatusCode()))
    if (resp.get_StatusCode() == 429):
        print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))

    #  Inspect this response locally; it can contain private Jira data.
    print(resp.bodyStr())
    sys.exit()

success = reply.Load(resp.bodyStr())
if (success != True):
    print("Expected a JSON object in the response.")
    sys.exit()

if (reply.JsonTypeOf("transitions") != 4):
    print("Expected an array: transitions")
    sys.exit()

i = 0
j = 0
fields = chilkat.CkJsonObject()
field = chilkat.CkJsonObject()
while (i < reply.SizeOfArray("transitions")) :
    reply.put_I(i)
    print(reply.stringOf("transitions[i].name") + " -> " + reply.stringOf("transitions[i].to.name"))
    if (reply.StringOfEquals("transitions[i].name",transitionName,True) == True):
        transitionId = reply.stringOf("transitions[i].id")
        matches = matches + 1
        # fields is a CkJsonObject
        fields = reply.ObjectOf("transitions[i].fields")
        if (reply.get_LastMethodSuccess() != True):
            print("Expected expanded transition field metadata.")
            sys.exit()

        j = 0
        while (j < fields.get_Size()) :
            # field is a CkJsonObject
            field = fields.ObjectAt(j)
            if (field.BoolOf("required") == True):
                needsFields = True
                print("Required transition field: " + fields.nameAt(j))

            j = j + 1

    i = i + 1

if ((matches != 1) or (needsFields == True)):
    print("Choose one available transition and supply any required transition fields before submitting.")
    sys.exit()

request = chilkat.CkJsonObject()
request.UpdateString("transition.id",transitionId)
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/{$issueKey}/transitions")
success = http.HttpJson("POST",url.getAsString(),request,"application/json",resp)
if (resp.get_StatusCode() == 0):
    print("No HTTP response was received. Check connectivity and TLS settings.")
    sys.exit()

if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    print("Request failed. HTTP " + str(resp.get_StatusCode()))
    if (resp.get_StatusCode() == 429):
        print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))

    #  Inspect this response locally; it can contain private Jira data.
    print(resp.bodyStr())
    sys.exit()

print("Transition completed: " + transitionName)