Documentation Index

Fetch the complete documentation index at: https://help.12dsynergy.com/llms.txt

Use this file to discover all available pages before exploring further.

Download Transmittal File

Prev Next

This tutorial demonstrates how to get issue details via the RESTful API.

The commands are provided in curl and can be run from the command prompt when the 12d Synergy Server is running (or in a batch script).

Additional API documentation

To get a list of most of the API requests available, with the 12d Synergy server running, browse http://synergy.myserver.com/api-docs/ui/index.

(Replace synergy.myserver.com with the external server address and update the port numbers if necessary.)

1.1. Getting the Personal Access Token to access API

The tutorial for getting the PAT is here: Generate PAT in Web client.

1.2. Get the Issue ID

To get the issue ID, set ID, and file name, you can follow the steps here: Get issued file-set for display

1.3. Downloading the Transmittal File

This request is available in the API Documentation under Issued Files.

Sample Request

curl --location 'http://localhost:8080/api/v1/issued-files/downloadTransmittalFile/{issue-id-here}/{set-id-here}/{file-name-here}' \

--header 'Authorization: Bearer <your-token-here>' \

--header 'Content-Type: application/json' \

Once the request is successful, you will get the binary data as a response.