Get
/api/v1/Authoring/projects/{projectId}/folders/{folderId}
Returns information about a specified folder
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
projectId
integer (int32) Required
Project containing the folder
folderId
integer (int32) Required
Folder to retrieve
Responses
200
OK
object
id
integer (int32)
The ID of the folder
name
string | null
The name of the folder
type
string
Valid values[
"Test",
"Job",
"Project"
]
createdBy
string | null
The creator name of the folder
dateCreated
string (date-time)
The creation date of the folder
dateModified
string (date-time)
The latest modification date of the folder
description
string | null
The description of the folder
parentFolder
string | null
The parent folder of the folder
tests
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null
The child tests of the folder
object
id
integer (int32)
The object's ID
name
string | null
The object's name
folders
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null
The child folders of the folder
object
id
integer (int32)
The object's ID
name
string | null
The object's name
jobs
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null
The child jobs of the folder
object
id
integer (int32)
The object's ID
name
string | null
The object's name
404
Not Found
object
error
string | null