API Reference
/
Connector API
/
Ticketing
/
List Attachments Metadata

Connector API

The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.

See the Synqly Overview for more information.

Download OpenAPI description
connectors.json
connectors.yaml
Languages
Servers
Synqly
https://api.synqly.com/

Assets

Operations

Edr

Operations

Hooks

Operations

Identity

Operations

Notifications

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Siem

Operations

Sink

Operations

Storage

Operations

Ticketing

Operations

Create Attachment

Request

[beta: currently supported by Jira] Creates an Attachment for the ticket with id {ticketId} in the token-linked Integration.

Path
ticketIdstring(Id)required
Bodyapplication/jsonrequired
file_namestringrequired

The name of the file.

contentstring(byte)required

File contents

curl -i -X POST \
  'https://api.synqly.com/v1/ticketing/attachments/{ticketId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "file_name": "string",
    "content": "string"
  }'

Responses

Bodyapplication/json
resultobject(AttachmentMetadata)required

Attachment in a ticketing system

result.​idstring(Id)required
result.​ticket_idstring(Id)required
result.​file_namestringrequired

The name of the file.

result.​file_typestringrequired

The type of the file.

result.​created_datestring(date-time)required

The date the attachment was created.

result.​creatorstringrequired

The user who created the attachment.

result.​file_sizeinteger or null

The size of the file in bytes.

result.​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

metaobject(MetaResponse)
Response
application/json
{
  "result": {
    "id": "string",
    "ticket_id": "string",
    "file_name": "string",
    "file_type": "string",
    "file_size": 0,
    "created_date": "2019-08-24T14:15:22Z",
    "creator": "string",
    "unmapped": {}
  },
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

List Attachments Metadata

Request

[beta: currently supported by Jira] Returns metadata for all Attachments for a Ticket object matching {ticketId} from the token-linked Integration.

Path
ticketIdstring(Id)required
curl -i -X GET \
  'https://api.synqly.com/v1/ticketing/attachments/{ticketId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(AttachmentMetadata)required
result[].​idstring(Id)required
result[].​ticket_idstring(Id)required
result[].​file_namestringrequired

The name of the file.

result[].​file_typestringrequired

The type of the file.

result[].​created_datestring(date-time)required

The date the attachment was created.

result[].​creatorstringrequired

The user who created the attachment.

result[].​file_sizeinteger or null

The size of the file in bytes.

result[].​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

cursorstringrequired

Cursor to use to retrieve the next page of results

metaobject(MetaResponse)
Response
application/json
{
  "result": [
    { … }
  ],
  "cursor": "string",
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Download Attachment

Request

[beta: currently supported by Jira] Downloads the Attachment object matching {attachmentId} for the Ticket matching {tickedId} from the token-linked Integration.

Path
ticketIdstring(Id)required
attachmentIdstring(Id)required
curl -i -X GET \
  'https://api.synqly.com/v1/ticketing/attachments/{ticketId}/{attachmentId}/download' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultobject(Attachment)required
result.​file_namestringrequired

The name of the file.

result.​file_typestringrequired

The type of the file.

result.​contentstring(byte)required

File contents

result.​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

metaobject(MetaResponse)
Response
application/json
{
  "result": {
    "file_name": "string",
    "file_type": "string",
    "content": "string",
    "unmapped": {}
  },
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Vulnerabilities

Operations