SQL Server Jira - Issues: Edit an Issue

Back to Index

Edits the issue from a JSON representation. This example updates the issue having key = "SCRUM-15". A successful update is indicated by a response status code equal to 204 with an empty response body.

Documentation: https://developers.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-put

CURL Command

curl -X PUT --user jira@example.com:JIRA_API_TOKEN \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "update": {
        "summary": [
          {
            "set": "Bug in business logic"
          }
        ],
        "labels": [
          {
            "add": "triaged"
          },
          {
            "remove": "blocker"
          }
        ]
      },
      "fields": {
        "customfield_10010": 1
      },
      "historyMetadata": {
        "type": "myplugin:type",
        "description": "text description",
        "descriptionKey": "plugin.changereason.i18.key",
        "activityDescription": "text description",
        "activityDescriptionKey": "plugin.activity.i18.key",
        "actor": {
          "id": "tony",
          "displayName": "Tony",
          "type": "mysystem-user",
          "avatarUrl": "http://mysystem/avatar/tony.jpg",
          "url": "http://mysystem/users/tony"
        },
        "generator": {
          "id": "mysystem-1",
          "type": "mysystem-application"
        },
        "cause": {
          "id": "myevent",
          "type": "mysystem-event"
        },
        "extraData": {
          "keyvalue": "extra data",
          "goes": "here"
        }
      },
      "properties": [
        {
          "key": "key1",
          "value": "can be set at issue create or update time"
        },
        {
          "key": "key2",
          "value": "and there can be multiple properties"
        }
      ]
    }' \
  --url 'https://your-domain.atlassian.net/rest/api/2/issue/SCRUM-15'

SQL Server Example

CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @rest int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    --  URL: https://your-domain.atlassian.net/rest/api/2/issue/SCRUM-15
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'your-domain.atlassian.net', STR(@port), STR(@bTls), STR(@bAutoReconnect)
    IF STR(@success) <> 1
      BEGIN

        EXEC sp_OAGetProperty @rest, 'ConnectFailReason', @iTmp0 OUT
        PRINT 'ConnectFailReason: ' + @iTmp0
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        RETURN
      END

    EXEC sp_OAMethod @rest, 'SetAuthBasic', @success OUT, 'jira@example.com', 'JIRA_API_TOKEN'

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'update.summary[0].set', 'Bug in business logic'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'update.labels[0].add', 'triaged'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'update.labels[1].remove', 'blocker'
    EXEC sp_OAMethod @json, 'UpdateNumber', @success OUT, 'fields.customfield_10010', '1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.type', 'myplugin:type'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.description', 'text description'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.descriptionKey', 'plugin.changereason.i18.key'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.activityDescription', 'text description'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.activityDescriptionKey', 'plugin.activity.i18.key'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.actor.id', 'tony'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.actor.displayName', 'Tony'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.actor.type', 'mysystem-user'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.actor.avatarUrl', 'http://mysystem/avatar/tony.jpg'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.actor.url', 'http://mysystem/users/tony'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.generator.id', 'mysystem-1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.generator.type', 'mysystem-application'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.cause.id', 'myevent'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.cause.type', 'mysystem-event'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.extraData.keyvalue', 'extra data'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'historyMetadata.extraData.goes', 'here'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'properties[0].key', 'key1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'properties[0].value', 'can be set at issue create or update time'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'properties[1].key', 'key2'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'properties[1].value', 'and there can be multiple properties'

    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Accept', 'application/json'

    DECLARE @sbRequestBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, STR(@sbRequestBody)
    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'PUT', '/rest/api/2/issue/SCRUM-15', STR(@sbRequestBody), STR(@sbResponseBody)
    IF STR(@success) <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END
    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @respStatusCode OUT
    IF STR(@respStatusCode) >= 400
      BEGIN

        PRINT 'Response Status Code = ' + STR(@respStatusCode)

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Response Body:'
        EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody
    EXEC @hr = sp_OADestroy @sbResponseBody


END
GO