Attachment

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Add Attachment

Upload a file attachment to Roubler. This endpoint uses multipart/form-data for file uploads following the GraphQL multipart request specification.

How File Uploads Work:

File uploads use a special multipart/form-data format that includes:

  1. operations - The GraphQL query and variables (with file: null)
  2. map - Mapping of file positions to variable paths
  3. file(s) - The actual file data

This follows the GraphQL multipart request specification.

Response Fields:

Field Description
id Unique identifier for the attachment
filename Name of the uploaded file
url Temporary download URL for the attachment

For the complete Attachment type reference and all available fields, see the GraphQL Schema Reference.

GraphQL Mutation

mutation AddAttachment($input: AddAttachmentInput!) {
  addAttachment(input: $input) {
    id
    filename
    url
  }
}

Multipart Request Structure

When making the request, you need to send multipart/form-data with three parts:

1. operations (text field):

{
  "query": "mutation AddAttachment($input: AddAttachmentInput!) { addAttachment(input: $input) { id filename url }}",
  "variables": {
    "input": {
      "file": null
    }
  }
}

2. map (text field):

{
  "1": ["variables.input.file"]
}

3. 1 (file field):

<actual file data>

Example cURL Request

curl -X POST "https://graphql.au.staging.roubler.net/graphql" \
  -H "Authorization: Bearer <access_token>" \
  -H "X-Company-ID: <company_id>" \
  -F 'operations={"query":"mutation AddAttachment($input: AddAttachmentInput!) { addAttachment(input: $input) { id filename url }}","variables":{"input":{"file":null}}}' \
  -F 'map={"1":["variables.input.file"]}' \
  -F '1=@/path/to/your/file.pdf'

Example Response

{
  "data": {
    "addAttachment": {
      "id": "251779",
      "filename": "file.pdf",
      "url": "https://roubler-staging-storage.s3.ap-southeast-2.amazonaws.com/attachments/251779?AWSAccessKeyId=...&Expires=1717996392&Signature=..."
    }
  }
}