Skip to content
developers
Open TestCollab

Get testplanlogs

GET/testplanlogs

Get logs for a specific test plan

Example

Section titled “Example”

Use resource IDs from your own project. Keep the API token in your server or CI environment.

example.ts
import { createConfiguration, TestplanlogsApi } from '@testcollab/sdk';


const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TestplanlogsApi(config);


const result = await api.getTestPlanLogs({});
console.log(result);

Parameters

Section titled “Parameters”
Name Location Type Required Description
project query number No Project ID
_limit query integer No Limit the size of the returned results
_start query integer No Skip a specific number of entries (for pagination)
_sort query string No Sort according to a specific field.
_filter query string No Stringified filter object (the filtering guide)
testplan query number No Test Plan ID

Response

Section titled “Response”

200 — List of testplanlogs

Field Type Required Description
[].log string Yes Type of entity
[].test_plan number Yes Test plan ID
[].test_plan_title string No Test plan title
[].test_case_title string No Test case title
[].test_plan_configuration number No Test plan configuration ID
[].test_plan_test_case number No Test plan test case ID
[].attachments Upload Collection No —
[].attachments[].id number Yes —
[].attachments[].name string Yes —
[].attachments[].hash string Yes —
[].attachments[].ext string Yes —
[].attachments[].mime string Yes —
[].attachments[].size string Yes —
[].attachments[].url string Yes —
[].attachments[].created_by number No —
[].attachments[].created_at string Yes —
[].attachments[].updated_at string Yes —
[].build Build Minified No Build (software version) the result recorded by this entry was executed against, if any (). Set only on entries that record a result, and never rewritten when the plan’s build changes later.
[].build.id number Yes —
[].build.version string Yes —
[].build.environment string No —
[].build.source string Yes Values: manual, ci.
[].build.release_date string No —
[].build.created_at string No —
[].execution_source string No How the result recorded by this entry was produced (). Set only on entries that record a result. Absent on entries written before this was tracked, which is why there is no “unknown” member - a missing value means it was never recorded, not that it was manual. Values: manual, ci, api, agent, import.
[].project Project Mini No —
[].project.id number Yes —
[].project.name string Yes —
[].project.archived boolean Yes —
[].project.activity string No —
[].project.totalTimeSpentLabel string No —
[].project.created_at string Yes —
[].project.updated_at string Yes —
[].activity_type string Yes Activity Type Values: add, edit, delete, publish, run, finished_run, comment, unlink.
[].user User Yes —
[].user.id number Yes —
[].user.name string Yes —
[].user.about_me string No —
[].user.email string Yes If email is modified then a confirmation should be sent
[].user.avatar Upload No —
[].user.avatar.id number Yes —
[].user.avatar.name string Yes —
[].user.avatar.hash string Yes —
[].user.avatar.ext string Yes —
[].user.avatar.mime string Yes —
[].user.avatar.size string Yes —
[].user.avatar.url string Yes —
[].user.avatar.created_by number No —
[].user.avatar.created_at string Yes —
[].user.avatar.updated_at string Yes —
[].user.username string No —
[].user.last_active string No —
[].user.confirmed boolean No —
[].user.rank string No Values: User, Administrator.
[].user.projects Project User Minified Collection No —
[].user.projects[].id number Yes —
[].user.projects[].user number Yes —
[].user.projects[].project number Yes —
[].user.projects[].role number Yes —
[].user.projects[].created_at string Yes —
[].user.projects[].updated_at string Yes —
[].user.created_at string No —
[].user.is_guest number No —
[].created_at string No Time when the activity was performed
Illustrative response
[]

Errors

Section titled “Errors”
Status Meaning
403 Forbidden

Next steps

Section titled “Next steps”