This tutorial demonstrates how to get issued file-set types by job and type via RESTful API.
The steps include:
Get the job ID from searching jobs
Get the type ID from another API call
Get the file-set types of a job using the job ID
The commands are provided in curl and can be run from the command prompt when the 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 job ID from the list of jobs
Refer to Search Jobs to get the required job ID.
1.3. Get the type ID from the list of file-set types
To get the type ID, you can follow the steps here: Get file set types of a job
1.4. Get the issued file-sets
This request can be found in the API Documentation under Issued Files marked 'Get issued file-set by job and type'.
Once you have the value for job_id and type_id, it should be included in the URL.
Sample Request
/curl --location 'http://localhost:8080/api/v1/issued-files/getIssuedFileSets?job_id={job-id-here}&type_id={type-id-here}' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \Below is a sample response when getting the file-set types by job ID and type ID. Click 
in the line below to see the code.
Sample Response
[
{
"add_all_referenced_files": false,
"versions": null,
"project_id": null,
"name": "Set 1",
"description": "<HTML><HEAD>\r\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\r\n<BODY>issue set 1</BODY></HTML>",
"created_by": {
"is_user": true,
"companies": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"first_name": "test",
"last_name": "test",
"email": "test@test.com",
"active": true,
"create_date": "2024-12-10T01:48:00.25",
"attributes": null,
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"created_date_utc": "2025-04-14T02:11:23.087",
"structure_root": null,
"has_issues": true,
"type_id": {
"_id": 4,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "4_1"
},
"set_version": 1,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
}
},
{
"add_all_referenced_files": false,
"versions": null,
"project_id": null,
"name": "Set from local 1",
"description": "<HTML><HEAD>\r\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\r\n<BODY></BODY></HTML>",
"created_by": {
"is_user": true,
"companies": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"first_name": "test",
"last_name": "test",
"email": "test@test.com",
"active": true,
"create_date": "2024-12-10T01:48:00.25",
"attributes": null,
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"created_date_utc": "2025-04-14T03:15:00.64",
"structure_root": null,
"has_issues": false,
"type_id": {
"_id": 4,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "4_1"
},
"set_version": 1,
"id": {
"_id": 2,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "2_1"
}
}
]