This tutorial demonstrates how to get issue tracking via RESTful API.
The steps include:
Get the issue tracking
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 issue tracking
This request can be found in the API Documentation under Issue-Tracking.
The EntityId below is an example and it is an EntityId of a job. You will have to replace the value with the ones you have.
Click 
in the line below to see the code.
Sample Request
POST curl --location 'http://localhost:8080/api/v1/issue-tracking/issues/get' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \
--data '{
"Page": 1,
"PageSize": 20,
"Filters": {
"EntityId": {
"_id": 40009,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "40009_1"
},
"EntityType": 0,
"ClosureStatusFilter": 2
}
}'
Below is a sample response when getting the issues. Click in the line below to see the code.
Sample Response
{
"PageNumber": 1,
"PageSize": 20,
"TotalRows": 2,
"TotalPages": 1,
"Result": [
{
"Id": {
"_id": 10007,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "10007_1"
},
"IssueKey": "2",
"IssueTicketTypeID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"IssueType": {
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Name": "Generic",
"CreatedBy": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"DefaultStatusId": 1,
"ColorHex": null,
"IDScheme": null,
"Workflow": null,
"AttachmentType": 0,
"Attributes": null
},
"StatusID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Status": {
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Name": "Not Started",
"IssueTicketType": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"WorkflowState": null,
"IsClosureState": false,
"ColorHex": "#FFA500",
"SortOrder": 1,
"Attributes": null
},
"CreatorContactID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Creator": {
"is_user": false,
"companies": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"first_name": "Drei",
"last_name": "Valencia",
"email": "test@test.com",
"active": true,
"create_date": "2024-09-16T23:42:30.113",
"attributes": null,
"image_modified_date_time": "2024-09-16T23:42:33.487"
},
"AssigneeContactID": null,
"Assignee": null,
"Title": "asd",
"Description": "<p>asd</p>",
"AttachmentID": {
"_id": 40009,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "40009_1"
},
"AttachmentType": 0,
"ParentId": null,
"ParentType": 0,
"RelativeTargetPath": "",
"HasGeometry": false,
"HasProperties": false,
"JobId": {
"_id": 40009,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "40009_1"
},
"EntityName": null,
"Version": 0,
"StartDate": null,
"DueDate": null,
"Attributes": null,
"Content": null,
"Watchers": null,
"Associations": null,
"WorkflowDataCapture": null
},
{
"Id": {
"_id": 10012,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "10012_1"
},
"IssueKey": "3",
"IssueTicketTypeID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"IssueType": {
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Name": "Generic",
"CreatedBy": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"DefaultStatusId": 1,
"ColorHex": null,
"IDScheme": null,
"Workflow": null,
"AttachmentType": 0,
"Attributes": null
},
"StatusID": {
"_id": 2,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "2_1"
},
"Status": {
"id": {
"_id": 2,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "2_1"
},
"Name": "In Progress",
"IssueTicketType": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"WorkflowState": null,
"IsClosureState": false,
"ColorHex": "#FFA500",
"SortOrder": 2,
"Attributes": null
},
"CreatorContactID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Creator": {
"is_user": false,
"companies": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"first_name": "Drei",
"last_name": "Valencia",
"email": "test@test.com",
"active": true,
"create_date": "2024-09-16T23:42:30.113",
"attributes": null,
"image_modified_date_time": "2024-09-16T23:42:33.487"
},
"AssigneeContactID": null,
"Assignee": null,
"Title": "sfassd issue",
"Description": "<p>asdsad</p>",
"AttachmentID": {
"_id": 580992,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "580992_1"
},
"AttachmentType": 99,
"ParentId": {
"_id": 450311,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "450311_1"
},
"ParentType": 9,
"RelativeTargetPath": "test 1/sfaasd.docx",
"HasGeometry": false,
"HasProperties": false,
"JobId": {
"_id": 40009,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "40009_1"
},
"EntityName": "sfaasd.docx",
"Version": 0,
"StartDate": null,
"DueDate": null,
"Attributes": null,
"Content": null,
"Watchers": null,
"Associations": null,
"WorkflowDataCapture": null
}
]
}