Automated Test Technologies
This chapter focuses on services for automated test technologies, they are only authorized for administrators.
Get automated test technology
A GET
to /automated-test-technologies/{id}
returns the automated test technology with the given id.
Path parameters
Parameter | Description |
---|---|
|
the id of the technology |
HTTP request
GET /api/rest/latest/automated-test-technologies/3 HTTP/1.1
Accept: application/json
Host: localhost:8080
Request parameters
Parameter | Description |
---|---|
|
which fields of the elements should be returned (optional) |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 247
{
"_type" : "automated-test-technology",
"id" : 3,
"name" : "JUnit",
"action_provider_key" : "junit/execute@v1",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/automated-test-technologies/3"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the type of the entity |
|
|
the id of the technology |
|
|
the name of the technology |
|
|
the action provider key of the technology |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this technology |
Get all automated test technologies
A GET
to /automated-test-technologies
returns all the automated test technologies.
HTTP request
GET /api/rest/latest/automated-test-technologies 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) |
|
which type of the element should be returned (optional) |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1192
{
"_embedded" : {
"automated-test-technologies" : [ {
"_type" : "automated-test-technology",
"id" : 1,
"name" : "Robot Framework",
"action_provider_key" : "robotframework/execute@v1",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/automated-test-technologies/1"
}
}
}, {
"_type" : "automated-test-technology",
"id" : 2,
"name" : "Cypress",
"action_provider_key" : "cypress/execute@v1",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/automated-test-technologies/2"
}
}
}, {
"_type" : "automated-test-technology",
"id" : 3,
"name" : "JUnit",
"action_provider_key" : "junit/execute@v1",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/automated-test-technologies/3"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/automated-test-technologies?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 3,
"totalPages" : 1,
"number" : 0
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the list of elements for that page |
|
|
the page size for that query |
|
|
total number of elements the user 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) |
Add an automated test technology
A POST
to /automated-test-technologies
inserts a new technology.
HTTP request
POST /api/rest/latest/automated-test-technologies HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 125
Host: localhost:8080
{
"_type" : "automated-test-technology",
"name" : "NewTechnology",
"action_provider_key" : "newtechnology/execute@v1"
}
Request fields
Path | Type | Description |
---|---|---|
|
|
the type of the entity |
|
|
the name of the technology |
|
|
the action provider key of the technology |
Request parameters
Parameter | Description |
---|---|
|
which fields of the elements should be returned (optional) |
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 263
{
"_type" : "automated-test-technology",
"id" : 4,
"name" : "NewTechnology",
"action_provider_key" : "newtechnology/execute@v1",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/automated-test-technologies/4"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the id of the entity |
|
|
the type of the entity |
|
|
the name of the technology |
|
|
the action provider key of the technology |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this technology |