Export Tests/Jobs

Prev Next
Post
/api/v1/Authoring/projects/{id}/export

Export a set of tests and/or jobs

Security
API Key: x-val-api-token
Header parameter namex-val-api-token

API key needed to access endpoints. Each Validatar user can manage their own set of API keys.

Path parameters
id
integer (int32) Required

ID of the project containing the exported objects

Body parameters

Information about the objects to be exported

object
name
string Required

Filename of the export file to generate

Min length1
description
string | null

Description of the export file

testFolderIds
Array of integer | null

List of test folder IDs to include in the export file

integer (int32)
jobFolderIds
Array of integer | null

List of job folder IDs to include in the export file

integer (int32)
testIds
Array of integer | null

List of test IDs to include in the export file

integer (int32)
jobIds
Array of integer | null

List of job IDs to include in the export file

integer (int32)
includeCustomFields
boolean

Whether to include custom fields in the export file

includeJobSchedules
boolean

Whether to include job schedules in the export file

object
name
string Required

Filename of the export file to generate

Min length1
description
string | null

Description of the export file

testFolderIds
Array of integer | null

List of test folder IDs to include in the export file

integer (int32)
jobFolderIds
Array of integer | null

List of job folder IDs to include in the export file

integer (int32)
testIds
Array of integer | null

List of test IDs to include in the export file

integer (int32)
jobIds
Array of integer | null

List of job IDs to include in the export file

integer (int32)
includeCustomFields
boolean

Whether to include custom fields in the export file

includeJobSchedules
boolean

Whether to include job schedules in the export file

object
name
string Required

Filename of the export file to generate

Min length1
description
string | null

Description of the export file

testFolderIds
Array of integer | null

List of test folder IDs to include in the export file

integer (int32)
jobFolderIds
Array of integer | null

List of job folder IDs to include in the export file

integer (int32)
testIds
Array of integer | null

List of test IDs to include in the export file

integer (int32)
jobIds
Array of integer | null

List of job IDs to include in the export file

integer (int32)
includeCustomFields
boolean

Whether to include custom fields in the export file

includeJobSchedules
boolean

Whether to include job schedules in the export file

object
name
string Required

Filename of the export file to generate

Min length1
description
string | null

Description of the export file

testFolderIds
Array of integer | null

List of test folder IDs to include in the export file

integer (int32)
jobFolderIds
Array of integer | null

List of job folder IDs to include in the export file

integer (int32)
testIds
Array of integer | null

List of test IDs to include in the export file

integer (int32)
jobIds
Array of integer | null

List of job IDs to include in the export file

integer (int32)
includeCustomFields
boolean

Whether to include custom fields in the export file

includeJobSchedules
boolean

Whether to include job schedules in the export file

Responses
200

OK

object
fileName
string | null

Name of the export file

mimeType
string | null

Mime type of the export file

contentBase64
string (byte) | null

Content of the export file formatted as a Base64 string

400

Bad Request

object
errors
Array of string | null
string