Synchronisations
This chapter focuses on synchronisations.
Get all synchronisations by project
A GET
to /projects/{id}/synchronisations
returns all the synchronisations that the client is allowed to read.
HTTP request
GET /api/rest/latest/projects/14/synchronisations?page=1&size=2 HTTP/1.1
Accept: application/json
Host: localhost:8080
Request parameters
Parameter | Description |
---|---|
|
number of the page to retrieve (optional) |
|
size of the page to retrieve (optional) |
|
which attributes of the returned entities should be sorted on (optional) |
|
which fields of the elements should be returned (optional) |
HTTP response
HTTP/1.1 200 OK
Content-Length: 1978
Content-Type: application/json;charset=UTF-8
{
"_embedded" : {
"synchronisations" : [ {
"_type" : "synchronisation",
"id" : 1,
"name" : "tata",
"server_name" : "BugtrackerDemo",
"server_id" : 3,
"select_type" : "BOARD",
"select_value" : "Tableau XS",
"additional_JQL" : "",
"synchronisation_path" : "/Test Project-1/demo2",
"restrain_to_active_sprint" : false,
"last_sync_date" : "2020/03/27 10:20",
"last_successful_sync_date" : "2020/03/27 10:20",
"last_status" : "Passed",
"status" : "Passed",
"activated" : false,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/synchronisations/1"
}
}
}, {
"_type" : "synchronisation",
"id" : 2,
"name" : "toto",
"server_name" : "BugtrackerDemo2",
"server_id" : 3,
"select_type" : "BOARD",
"select_value" : "Tableau XS",
"additional_JQL" : "",
"synchronisation_path" : "/Test Project-1/demo2",
"restrain_to_active_sprint" : false,
"last_sync_date" : "2020/03/27 10:20",
"last_successful_sync_date" : "2020/03/27 10:20",
"last_status" : "Passed",
"status" : "Passed",
"activated" : false,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/synchronisations/2"
}
}
} ]
},
"_links" : {
"first" : {
"href" : "http://localhost:8080/api/rest/latest/projects/14/synchronisations?page=0&size=2"
},
"prev" : {
"href" : "http://localhost:8080/api/rest/latest/projects/14/synchronisations?page=0&size=2"
},
"self" : {
"href" : "http://localhost:8080/api/rest/latest/projects/14/synchronisations?page=1&size=2"
},
"last" : {
"href" : "http://localhost:8080/api/rest/latest/projects/14/synchronisations?page=1&size=2"
}
},
"page" : {
"size" : 2,
"totalElements" : 4,
"totalPages" : 2,
"number" : 1
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the list of elements for that page |
|
|
the page size for that query |
|
|
total number of elements the client is allowed to read |
|
|
how many pages can be browsed |
|
|
the page number |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to the first page (optional) |
|
link to the previous page (optional) |
|
link to this page |
|
link to the next page (optional) |
|
link to the last page (optional) |
Get synchronisation
A GET
to /synchronisations/{id}
returns the synchronisation with the given id.
Path parameters
Parameter | Description |
---|---|
|
the id of the synchronisation |
HTTP request
GET /api/rest/latest/synchronisations/3 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Length: 580
Content-Type: application/json;charset=UTF-8
{
"_type" : "synchronisation",
"id" : 3,
"name" : "tata",
"server_name" : "BugtrackerDemo3",
"server_id" : 123,
"select_type" : "BOARD",
"select_value" : "Tableau XS",
"additional_JQL" : "",
"synchronisation_path" : "/Test Project-1/demo2",
"restrain_to_active_sprint" : false,
"last_sync_date" : "2020/03/27 10:20",
"last_successful_sync_date" : "2020/03/27 10:20",
"last_status" : "Passed",
"status" : "Passed",
"activated" : false,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/synchronisations/3"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the id of the entity |
|
|
the type of the entity |
|
|
name of the bug-tracker use for the current synchronisation |
|
|
id of the bug-tracker use for the current synchronisation |
|
|
name of the synchronisation |
|
|
select type |
|
|
select value |
|
|
JQL script |
|
|
directory where the requirement synchronize is save in Squash TM |
|
|
restrain to active sprint |
|
|
last synchronisation date |
|
|
last successful synchronisation date |
|
|
last status |
|
|
status |
|
|
enable/desable synchronisation |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this synchronisation |
Create synchronisation
A POST
to /projects/{id}/synchronisations
creates a new synchronisation.
HTTP request
POST /api/rest/latest/projects/14/synchronisations HTTP/1.1
Accept: application/json
Content-Length: 183
Content-Type: application/json
Host: localhost:8080
{
"name" : "demoSynchro",
"synchronisation_path" : "/Test Project-1/demo2",
"select_type" : "BOARD",
"select_value" : "Tableau XS",
"server_id" : 14,
"activated" : false
}
Request fields
Path | Type | Description |
---|---|---|
|
|
name of the synchronisation (mandatory) |
|
|
directory where the synchronized requirements are saved in Squash TM (mandatory) |
|
|
select type (mandatory) |
|
|
select value (mandatory) |
|
|
id of the bug tracker use for the current synchronisation (mandatory) |
|
|
whether the synchronisation is activated |
Request parameters
Parameter | Description |
---|---|
|
which fields of the elements should be returned (optional) |
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 586
{
"_type" : "synchronisation",
"id" : 4,
"name" : "demoSynchro",
"server_name" : "BugtrackerDemo3",
"server_id" : 14,
"select_type" : "BOARD",
"select_value" : "Tableau XS",
"additional_JQL" : "",
"synchronisation_path" : "/Test Project-1/demo2",
"restrain_to_active_sprint" : false,
"last_sync_date" : "2020/03/27 10:20",
"last_successful_sync_date" : "2020/03/27 10:20",
"last_status" : "Passed",
"status" : "Passed",
"activated" : false,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/synchronisations/4"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the id of the entity |
|
|
the type of the entity |
|
|
name of the bug tracker used for the current synchronisation |
|
|
id of the bug tracker used for the current synchronisation |
|
|
name of the synchronisation |
|
|
select type |
|
|
select value |
|
|
JQL script |
|
|
directory where the synchronized requirements are saved in Squash TM |
|
|
restrain to active sprint |
|
|
last synchronisation date |
|
|
last successful synchronisation date |
|
|
last status |
|
|
status |
|
|
enable/disable synchronisation |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this synchronisation |
Modify synchronisation
A PATCH
to /synchronisations/{id}
modifies synchronisation with the given id. Only name, select value and additional JQL which can be modified
HTTP request
PATCH /api/rest/latest/synchronisations/4 HTTP/1.1
Accept: application/json
Content-Length: 92
Content-Type: application/json
Host: localhost:8080
{
"name" : "UpdateDemoSynchro",
"select_value" : "tab Update",
"additional_JQL" : ""
}
Path parameters
Parameter | Description |
---|---|
|
the id of the synchronisation |
HTTP response
HTTP/1.1 200 OK
Content-Length: 592
Content-Type: application/json;charset=UTF-8
{
"_type" : "synchronisation",
"id" : 4,
"name" : "UpdateDemoSynchro",
"server_name" : "BugtrackerDemo3",
"server_id" : 14,
"select_type" : "BOARD",
"select_value" : "tab Update",
"additional_JQL" : "",
"synchronisation_path" : "/Test Project-1/demo2",
"restrain_to_active_sprint" : false,
"last_sync_date" : "2020/03/27 10:20",
"last_successful_sync_date" : "2020/03/27 10:20",
"last_status" : "Passed",
"status" : "Passed",
"activated" : false,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/synchronisations/4"
}
}
}
Activate/deactivate synchronisation
A PATCH
to /synchronisations/{id}
modifies the name of the synchronisation with the given id.
HTTP request
PATCH /api/rest/latest/synchronisations/4/activate?enabled=true HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: localhost:8080
Path parameters
Parameter | Description |
---|---|
|
the id of the synchronisation |
HTTP response
HTTP/1.1 200 OK
Content-Length: 582
Content-Type: application/json;charset=UTF-8
{
"_type" : "synchronisation",
"id" : 4,
"name" : "DemoSynchro",
"server_name" : "BugtrackerDemo3",
"server_id" : 14,
"select_type" : "BOARD",
"select_value" : "Tableau",
"additional_JQL" : "",
"synchronisation_path" : "/Test Project-1/demo2",
"restrain_to_active_sprint" : false,
"last_sync_date" : "2020/05/25 10:20",
"last_successful_sync_date" : "2020/05/25 10:20",
"last_status" : "Passed",
"status" : "Passed",
"activated" : true,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/synchronisations/4"
}
}
}
Launch Synchronisation
A GET
to /synchronisations/{id}/synchronize
launch synchronisation project
HTTP request
GET /api/rest/latest/synchronisations/4/synchronize HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: localhost:8080
Path parameters
Parameter | Description |
---|---|
|
the id of the synchronisation |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 586
{
"_type" : "synchronisation",
"id" : 4,
"name" : "demoSynchro",
"server_name" : "BugtrackerDemo3",
"server_id" : 14,
"select_type" : "BOARD",
"select_value" : "Tableau XS",
"additional_JQL" : "",
"synchronisation_path" : "/Test Project-1/demo2",
"restrain_to_active_sprint" : false,
"last_sync_date" : "2020/03/27 10:20",
"last_successful_sync_date" : "2020/03/27 10:20",
"last_status" : "Passed",
"status" : "Passed",
"activated" : false,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/synchronisations/4"
}
}
}
Delete synchronisation
A DELETE
to /synchronisations/{id}
deletes the synchronisation with the given id.
HTTP request
DELETE /api/rest/latest/synchronisations/12 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: localhost:8080
Path parameters
Parameter | Description |
---|---|
|
the id of the synchronisation |
HTTP response
HTTP/1.1 204 No Content