Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printabletrue

...

Table of Contents

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printabletrue

When the connection is configured and the URL endpoint and API token are created, you can use the URL endpoint and API token to transfer attachments from the source instance (where the app is installed) to the target cloud instance. You can use these credentials either through Jira automation, or your own app.

...

  • Web request URL

    • Fill with the generated URL endpoint, e.g.:

      • https://attachments-transfer-api.twinit.app/gateway/transferAttachments?id=aef469b5-34e5-4e16-942f-d3916d33b6b5

  • HTTP method

    • POST

  • Web request body

    • Custom data

      • jql (string) - (Required): The JQL query to find the target issue.

        • JQL has a limit of 10 issues per automation action!

      • sourceKey (string) - (Required): The key of the source issue.

      • commentId (string) - (Optional): The ID of the comment (if applicable):

        • If the commentId is included, only the attachments related to the specific comment will be sent. If the commentId is absent, all the issue attachments will be transferred.

        • You can use the {{issue.comment.last.id}} smart value to send the attachments attached to the last comment on the issue. If you need to send the attachment attached to the specific comment(s), use the specific commentId value(s) of the commentId instead of the smart value.

          • If the {{issue.comment.last.id}} smart value is added, you can also decide whether to create a comment (with the attachments links) or not. By default, the comment will be created on the target instance with the attachment links. If you don’t want to create a comment on the target instance, add createCommentcreateAsComment: false in the request body.

Code Block
{
  "jql": "issuekey = ITSM-1",
  "sourceKey": "{{issue.key}}",
  "commentId": "{{issue.comment.last.id}}",
  "createCommentcreateAsComment": true
}
Info
  • If the {{issue.comment.last.id}} smart value with createCommentcreateAsComment: true is used, a comment will be created on the target instance, with links to the attachments:

    image-20250209-130208.png
  • If the last comment does not contain an attachment, the comment will not be created on the target instance.

...

The Automation action might look like this:

...

Info

Validating the automation will send a request/file(s) to the Endpoint!

After configuring the automation, the attachment will be sent to the target instance, based on the defined trigger(s).

Infonote

The target and the source issue should not be the same. In this case, you will see the corresponding message in the audit log of the automation:

...

Code Block
{
  "jql": "issuekey IN ({{issue.targetkeys}})",
  "sourceKey": "{{issue.key}}"
}
  • Send all the attachments attachment(s) of the issue on a trigger to the issues ITSM-1 and ITSM-20 on the target instance:last comment (without creating a comment) in the issue of the target instance, the key of which is written in the targetkey field of the source issue.

Code Block
{
  "jql": "\"issuekeytargetkey\" IN (ITSM-1, ITSM-20)~ {{issue.key}}",
  "sourceKey": "{{issue.key}}"
}

...

,

...

Code Block
{
  "jqlcommentId": "issuekey = ITSM-1",
  "sourceKey": "{{issue.key{{issue.comment.last.id}}",
  "commentIdcreateAsComment": "{{issue.comment.last.id}}"
}

...

Info

Clicking the attachment name will open it.

...

false
}
  • Send all the attachments of the issue on a trigger to the issues ITSM-1 and ITSM-20 on the target instance:

Code Block
{
  "jql": "issuekey =IN (ITSM-1, ITSM-20)",
  "sourceKey": "{{issue.key}}",
  "commentId": "{{issue.comment.last.id}}",
}
  • Send the attachment of the last comment in a trigger, creating a comment on a target cloud instance with the link to the attachment:

Code Block
{
  "createCommentjql": false
}

Send attachments to Assets

Based on various triggers, you can send the files attached to the issue to the Assets of the same or another instance. The files will be attached to the Asset objects as attachments:

...

To send files to the Asset objects, create a Jira automation on the desired trigger (e.g. Issue created) with the “Send web request“ action. Use the generated URL endpoint for the “Web Request URL“. To authenticate your API requests, include an Authorization header in each request. The value of this header should be the API token generated from the API Tokens in the Settings. See the “Send web request“ action example below:

...

Web request URL

...

HTTP method

  • POST

Web request body

Custom data

...

 "issuekey = ITSM-1",
  "sourceKey": "{{issue.key}}",
  "commentId": "{{issue.comment.last.id}}"
}

...

Info

Clicking the attachment name will open it.

  • Send the attachment of the last comment on a trigger, without creating a comment on a target cloud instance:

Code Block
{
  "jql": "issuekey = ITSM-1",
  "sourceKey": "{{issue.key}}",
  "commentId": "{{issue.comment.last.id}}",
  "createAsComment": false
}

Send attachments to Assets

Based on various triggers, you can send the files attached to the issue to the Assets of the same or another instance. The files will be attached to the Asset objects as attachments:

...

To send files to the Asset objects, create a Jira automation on the desired trigger (e.g. Issue created) with the “Send web request“ action. Use the generated URL endpoint for the “Web Request URL“. To authenticate your API requests, include an Authorization header in each request. The value of this header should be the API token generated from the API Tokens in the Settings. See the “Send web request“ action example below:

  • Web request URL

  • HTTP method

    • POST

  • Web request body

    • Custom data

      • aql (string) - (Required): The AQL query to find the target object.

      • sourceKey (string) - (Required): The key of the source issue.

      • commentId (string) - (Optional): The ID of the comment (if applicable):

        • If the commentId is included, only the attachments related to the specific comment will be sent. If the commentId is absent, all the issue attachments will be transferred.

        • You can use the {{issue.comment.last.id}} smart value to send the attachments attached to the last comment on the issue. If you need to send the attachment attached to the specific comment(s), use the specific commentId value(s) of the commentId instead of the smart value.

...

Key

Value

Accept

Application/JSON

Authorization

Use the generated API token for the value in the Authorization header.

...

Info

Validating the automation will send a request/file(s) to the Endpoint!

After configuring the automation, the attachment will be sent to the Asset object of the target instance, based on the defined trigger(s).

Infonote

The target and the source issue should not be the same. In this case, you will see the corresponding message in the audit log of the automation:

...

Note

If several attachments are sent to several objects, depending on the number and size of the attachments, the automation log may return “Response 408 SocketException: Socket closed”. However, this might be a false error and the attachments will be sent to the objects.

...

Code Block
{
  "jql": "issuekey = ITSM-1",
  "sourceKey": "ITSM-15",
  "commentId": "12345"
}

curl example

Code Block
curl --request POST \
  --url 'https://attachments-transfer-api.twinit.app/gateway/transferAttachments?id=aef469b5-34e5-4e16-942f-d3916d33b6b5 '
  --header 'Accept: application/json' \
  --header 'Authorization: 46f61f78-e138-4019-85a0-e239878f2c94'
  --data ' {
  "jql": "issuekey = ITSM-1",
  "sourceKey": "ITSM-15",
  "commentId": "12345"
}'
  "sourceKey": "ITSM-15",
  "commentId": "12345"
}'

Audit log

You can track all the requests in the Audit Log. To access the log, click the Audit log button on the “URL Endpoint” section of the settings:

...

Clicking the button will navigate you to the audit lot that shows the list of the requests:

...

Info

The audit log shows the request history for the last two months!

A maximum of 20 log entries will be shown per single page.

You can filter the log by:

  • Period

    • Anytime (shows all the available logs)

    • Today

    • Last 3 days

    • Last 7 days

    • Custom (select starting and the end dates)

      image-20250219-155008.pngImage Added
  • Status

    • All (shows request with all the statuses)

    • Success (shows successful requests)

    • Error (shows failed requests)

You can also search the entries by a search term. The field searched the entries by the URL endpoint name and Audit log ID.

After selecting the filters, click the “Search“ button to filter the log entries based on the selection.

For the request entries, the grid shows the following information:

  • Date & time

    • When the request was sent

  • Audit log ID

    • ID (order number) of the entry

  • URL Endpoint

  • Status

    • Success or Error

  • Operations

    • Clicking “Show more“ or anywhere on the entry row will expand the log details:

...

Info

Updating the log may take some seconds after the request is sent. To retrieve the logs immediately, click the refresh button:

image-20250219-160001.pngImage Added