This tutorial demonstrates how to check if an issue has a transmittal file 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. Getting the issue ID
To get the issue ID, you can follow the steps here: Get issued file-set for display.
1.3. Checking the Issued File-set
This request is in the API Documentation under Issued Files marked 'Whether or not issue has a transmittal file'.
Sample Request
curl --location 'http://localhost:8080/api/v1/issued-files/hasStoredTransmittalFile/{issue-id-here}' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \Below is a sample response to check whether the issue has a transmittal file.
Sample Response
true