Get file-set types of a job

Prev Next

This tutorial demonstrates how to get file-set types of a job via RESTful API.

The steps include:

  • Get the job ID from searching jobs

  • 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 initial task states

This request can be found in the API Documentation under Issued Files marked 'Get file-set types of a job'.

Once you have the value for job_id, it should be included in the URL.

Sample Request

curl --location 'http://localhost:8080/api/v1/issued-files/getJobFileSetTypes/{job-id-here}' \

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

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

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

Sample Response

[
    {
        "num_file_sets": 0,
        "type_id": {
            "_id": 3,
            "_server_id": 1,
            "_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
            "IDString": "3_1"
        },
        "type_name": "test",
        "description": ""
    },
    {
        "num_file_sets": 2,
        "type_id": {
            "_id": 4,
            "_server_id": 1,
            "_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
            "IDString": "4_1"
        },
        "type_name": "Internal",
        "description": ""
    },
    {
        "num_file_sets": 0,
        "type_id": {
            "_id": 10002,
            "_server_id": 1,
            "_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
            "IDString": "10002_1"
        },
        "type_name": "External Test",
        "description": ""
    }
]