This tutorial demonstrates how to create an issued file-set 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 Job ID
Refer to Search Jobs to get the required job ID.
1.3. Getting the Type ID
To get the type ID, follow the steps here: Get file set types of a job.
1.4. Creating Issued File Set
This request is in the API Documentation under Issued Files marked 'Create Issued FileSet'.
Click
in the line below to see the code.
Sample Request
POST curl --location 'http://localhost:8080/api/v1/issued-files/createIssuedFileSet' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \
--data '{
"SetName": "Test from Postman 1",
"Description": "",
"TypeId": {
"_id": 1,
"_server_id": 1,
"_server_guid": "7341e777-cd38-4bf7-9ea6-7fd912e6b11e",
"IDString": "1_1"
},
"JobId": {
"_id": 1,
"_server_id": 1,
"_server_guid": "7341e777-cd38-4bf7-9ea6-7fd912e6b11e",
"IDString": "1_1"
}
}'Once the request is successful, you will get the response below. Click
in the line below to see the code.
Sample Response
{
"add_all_referenced_files": false,
"versions": [
{
"added_dates": {},
"files": [],
"issues": [],
"version": 1
}
],
"project_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"name": "Test from Postman 1",
"description": "",
"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-06-25T06:32:19.593",
"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": 10004,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "10004_1"
}
}