Forge REST API Extension Home
"Our app is engineered to offer Webtriggers (REST API in Forge), enabling functions typically unavailable in Atlassian, thereby unlocking the potential of Automations. If you're seeking a new endpoint, feel free to reach out to us. We can develop and integrate the desired endpoint within just a few days.
Create Attachment in Jira
Description
Creates an attachment in a Jira issue.
Usecase:
Automations does not allow you to write binary data which is needed to the Add Attachment API of Jira (https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-rest-api-3-issue-issueidorkey-attachments-post)
Endpoint
Access the App Configuration Page to get the Endpoint.
Method:
POST
Query Parameters
issueId
(string): The ID of the Jira issue to which the attachment will be added.fileName
(string): The name of the file to be attached.
Post Parameter
the whole body will be written to the attachment
Response
Success: JSON object with attachment details (https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-rest-api-3-issue-issueidorkey-attachments-post-responses)
Failure: Error message with details.
Read Attachment as File
Description
Reads an attachment from Jira as a file.
Endpoint
Access the App Configuration Page to get the Endpoint.
Method:
GET
Query Parameters
attachmentId
(string): The ID of the attachment to be read.
Response
Success: File data of the attachment as JSON object (https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-rest-api-3-attachment-content-id-get)
{attachmentContent: "CONTENT"}
Failure: Error message with details.
3. Decode Base64 Data
Description
Decodes a Base64 encoded string.
Endpoint
Access the App Configuration Page to get the Endpoint.
Method:
POST
Query Parameters
None
Body Parameters
(string): The Base64 encoded string to be decoded
Response
Success: Decoded string.
Failure: Error message with details.
4. Encode to Base64
Description
Encodes a string into Base64 format.
Method:
POST
Query Parameters
None
Body Parameters
(string): The string to be Base64 encoded
Response
Success: Base64 encoded string.
Failure: Error message with details.