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.

Get Issued File-set Version Files

Prev Next

This tutorial demonstrates how to get the issued file-set version files 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 Set ID

To get the set ID, you can follow the steps here: Get issued file-set types by job and type

1.3. Getting the Issued File-set Version Files

This request is in the API Documentation under Issued Files marked 'Get issued file-set version files'.

Once you have the value for set_id and set_version, it should be included in the URL.

Sample Request

curl --location 'http://localhost:8080/api/v1/issued-files/getIssuedFileSetVersionFiles/{set-id-here}/{set-version-here}' \

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

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

Below is a sample response when getting the file-set types version file. Click  in the line below to see the code.

Sample Response

[

    {

        "file_name": "sfaasd.docx",

        "version": 2,

        "last_user_name": "test",

        "last_user_id": {

            "_id": 1,

            "_server_id": 1,

            "_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",

            "IDString": "1_1"

        },

        "last_change_time": "2025-06-24T05:01:43.083",

        "last_change_type": 2,

        "file_id": {

            "_id": 450311,

            "_server_id": 1,

            "_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",

            "IDString": "450311_1"

        },

        "folder_id": {

            "_id": 420427,

            "_server_id": 1,

            "_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",

            "IDString": "420427_1"

        },

        "active_check_out": null,

        "active_folder_check_out": null,

        "change_attribs": [],

        "file_size": 1199,

        "has_file_access": true,

        "file_access": 1,

        "flattened_parent_attributes": null,

        "path": "test 1/sfaasd.docx",

        "has_references": false,

        "has_folder_references": false,

        "latest_version": 2,

        "file_type": 0,

        "link_source_id": null,

        "link_path": "",

        "preview_state": 1,

        "is_link_source": false,

        "file_modified_utc": "2025-06-24T04:52:51.217",

        "file_created_utc": "2025-06-24T04:52:51.207",

        "display_name": "",

        "workflows": null,

        "file_lock": null,

        "is_referenced": false,

        "file_store": null,

        "has_layouts": false,

        "extension_data": null,

        "has_geometry": false,

        "has_properties": false,

        "Microsoft365Session": null,

        "attributes": []

    }

]