Cloud Runner Test User REST API
Manages test user jobs to be executed in a cloud runner for Automated Test Framework (ATF).
The Cloud Runner Test User API requires the ATF Test Generator and Cloud Runner (sn_atf_tg) plugin. The methods available with this API run in the now namespace and can be called using API Name, One-click regression testing for ATF, in the REST API Explorer. The admin role is required to access this API.
- Start the user test job.
- Set the cloud user.
- Check if the user specified is valid.
- Check the progress of the user test job.
- Cancel the test job.
The Cloud Runner Test Runner API may be used in tandem with the Cloud Runner Test Generation REST API and Cloud Runner Test User REST API. For instance, you can generate a test (Cloud Runner Test Generation API) and then get the progress of the test in the browser orchestration queue (Cloud Runner TEST Generation API) and check the number of tests that passed or failed.
To view the Server API reference documentation of this API, see Cloud Runner TestUserApi – Scoped, Global.
Cloud Runner Test User - GET /now/sn_atf_tg/test_user_progress
Provides the status of the test user job for a provided Browser Orchestration Queue (BOQ) record.
URL format
Default URL: GET /api/now/sn_atf_tg/test_user_progress
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| snboqId | Required. BOQ record sys_id of the test user job to get the progress of. Data Type: String Table: BOQ [sn_atf_tg_sn_boq] |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: application/json or application/xml.
Default: application/json |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successfully retrieved the progress of the test user job. |
| 400 | Error getting BOQ record status. Returns one of the following
messages:
|
| 403 | Error granting user access to the endpoint. Ensure that the user has the admin role. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| result | Object containing the progress results of the test runner job or a message
explaining why the request
failed.Or: Data type: Object |
| result.message | Error message detailing why the test runner progress cannot be retrieved. The
message parameter is not returned in a successful response. Data type: String |
| result.progress | Percentage that indicates how close to completion a test is while in a running state. Data type: Number |
| result.state | Current status of the BOQ record. Possible values:
Data type: String |
cURL request
The following request example shows how to check the progress of a test user job.
curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user_progress?snboqId=<sys_id of SNBOQ record>" \
--request GET \
--header "Accept:application/json" \
--user "username:password"Response body:
{
"result": {
"progress": 100,
"state": "completed"
}
}Cloud Runner Test User - GET /now/sn_atf_tg/is_valid_cloud_user
Checks whether a provided user is a valid cloud user.
- Exists,
- Is active,
- Is not locked out,
- Needs a password reset,
- Is an admin,
- Is read-only,
- Is web services-only
URL format
Default URL: GET /api/now/sn_atf_tg/is_valid_cloud_user
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| username | Required. User name of the sys_user to check if the user passes the following baseline criteria.
If any of these conditions fail, the API returns a false boolean with a message about which criteria failed. Data type: String |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: application/json or application/xml.
Default: application/json |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Returns true or false if the user is valid and satisfies cloud user criteria. |
| 403 | Error granting user access to the endpoint. Ensure that the user has the admin role. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| result | Object containing the results of the
request.Data type: Object |
| result.validUser | Flag that indicates whether the user satisfies cloud user criteria. When true,
the user satisfies the criteria. Data type: Boolean |
cURL request
The following request checks if the provided sys_user meets the criteria to use cloud functionality.
curl "http://instance.service-now.com/api/now/sn_atf_tg/is_valid_cloud_user?username=<username of sys_user to check>" \
--request GET \
--header "Accept:application/json" \
--user "username:password"Response body:
{
"result": {
"validUser": <Boolean value indicating whether user is valid cloud user>
}
}Cloud Runner Test User - POST /now/sn_atf_tg/test_user
Inserts a test user job into the BOQ [sn_atf_tg_sn_boq] table for a given user name, which is then run on cloud runner.
URL format
Default URL: POST /api/now/sn_atf_tg/test_user
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| username | Required. Username of the sys_user to test the end-to-end infrastructure of the
cloud runner. Data type: String |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: application/json or application/xml.
Default: application/json |
| Content-Type | Data format of the request body. Supported types: application/json or application/xml.
Default: application/json |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successfully inserted a test user BOQ job. |
| 400 | Error starting test user job. If an empty user name is provided or a user can’t be found in sys_user table, the server throws an error. |
| 403 | Error granting user access to the endpoint. Ensure that the user has the admin role. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| result | Object containing the results of the request.Or: Data type: Object |
| result.message | Error message detailing why the username cannot be assigned test capabilities.
The message parameter is not returned in a successful response. Data type: String |
| result.snboqId | Sys_id of the BOQ record that is inserted when test user job starts successfully. Data type: String Table: BOQ [sn_atf_tg_sn_boq] |
cURL request
The following request example shows how to insert a test user job into the BOQ [sn_atf_tg_sn_boq] table for a given username.
curl "http://instance.service-now.com/api/now/sn_atf_tg/test_user" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"username\":\"<username of sys_user to test cloud infrastructure>\"}" \
--user "username:password"The response returns a sys_id of the BOQ record that is inserted when test user job starts.
{
"result": {
"snboqId": "<sys_id of newly inserted BOQ record>"
}
}The following example returns a 400 error message when no user name or an invalid user name is passed.
curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user" \
--request POST \
--header "Accept:application/json" \
--user "username:password"Response:
{
"result": {
"message": "Unable to set cloud user as cloud user not valid"
}
}Cloud Runner Test User - POST /now/sn_atf_tg/cancel_test_user
Sets the test user job status in the Browser Orchestration Queue (BOQ) [sn_atf_tg_sn_boq] table to complete.
URL format
Default URL: POST /api/now/sn_atf_tg/cancel_test_user
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| snboqId | Required. Sys_id of the BOQ record to cancel associated with the test user job. Data Type: String Table: SNBOQ [sn_atf_tg_sn_boq] |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: application/json or application/xml.
Default: application/json |
| Content-Type | Data format of the request body. Supported types: application/json or application/xml.
Default: application/json |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successfully canceled the BOQ job. |
| 400 | Error canceling job. Returns one of the following messages:
|
| 403 | Error granting user access to the endpoint. Ensure that the user has the admin role. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| result | Object containing the results of the
request.Data type: Object |
| result.message | Message detailing whether the test user cancellation was successful. Data type: String |
cURL request
The following request demonstrates how to cancel a test user job in the Browser Orchestration Queue [sn_atf_tg_sn_boq] table.
curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_user" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \
--user "username:password"Successful response body:
{
"result": {
"message": "success"
}
}Cloud Runner Test User - POST /now/sn_atf_tg/select_cloud_user
Starts an end-to-end test user job on cloud runner. If the user is able to log in with the admin role, the cloud user property defaults to this user for future test runs and test generations.
URL format
Default URL: POST /api/now/sn_atf_tg/select_cloud_user
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| username | Required. User name of the sys_user to test and set the cloud user for future
test runner and test generation jobs. Data type: String |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: application/json or application/xml.
Default: application/json |
| Content-Type | Data format of the request body. Supported types: application/json or application/xml.
Default: application/json |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successfully tested the end to end cloud runner infrastructure and set the cloud user for future test run and test generation jobs. |
| 400 | Error testing the full end to end cloud runner infrastructure and setting the cloud user. Ensure that the user name isn’t empty or that the user exists in the sys_user table for a given user name. |
| 403 | Error granting user access to the endpoint. Ensure that the user has the admin role. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| result | Object containing the results of the
request.Data type: Object |
| result.message | Message detailing whether the user was successfully selected for future test
runs and test generations on the cloud runner infrastructure. Data type: String |
cURL request
The following example shows how to request a specific user to be selected for future test runs and test generations on the cloud runner infrastructure.
curl "https://instance.service-now.com/api/now/sn_atf_tg/select_cloud_user" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"username\":\"<username of sys_user to set as cloud user>\"}" \
--user "username:password"The response body returns a success message indicating that the cloud user is successfully selected for test runs and generations.
{
"result": {
"message": "success"
}
}