This tutorial demonstrates how to create a folder via RESTful API.
The steps include:
Search for a job to retrieve the job ID
Search for job items using the job ID
Search for a folder from the job item response to retrieve the folder ID
Using the job ID and folder ID to create a folder
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. Retrieving Job ID
Refer to Search Jobs to lto get the required job ID.
After selecting a job ID from the response above, the next step is to get the job items using the job ID.
Once you have selected a folder from the job items response, you can use that folder ID to create the folder.
Sample Request
curl --location 'http://synergy.myserver.com/api/v1/folders/create' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \
--data '{
"job_id": {
"_id": 1,
"_server_id": 0,
"_server_guid": "17200fcf-eb32-4771-84fd-9ab138528562",
"IDString": "1_1"
},
"parent_folder_id": {
"_id": 2,
"_server_id": 0,
"_server_guid": "17200fcf-eb32-4771-84fd-9ab138528562",
"IDString": "2_1"
},
"folder_name": "<folder-name-here>"
}'A successful response would look like this:
Sample Response
{
"_id": 190164,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "190164_1"
}