TestRail

Sync test cases, runs, and results from TestRail.

Overview
Setup Guide
Permissions
Troubleshooting

Connect Parable to TestRail for test case management and quality metrics.

Test Cases

Cases, sections, suites

Results

Runs, results, statistics

Data streams

This Provider Plugin defines 8 data streams.

Stream	Description	Sync
`users`	All TestRail users	full
`projects`	All TestRail projects	full
`suites`	Test suites for a project. Returns a bare array for single-suite projects and a paginated dict for multi-suite projects.	full
`cases`	Test cases for a project/suite combination	full
`plans`	Test plans for a project	full
`runs`	Test runs for a project	full
`tests`	Tests within a run	full
`results`	Test results for a run	incremental

What You’ll Need

Credential	What it is
Email	Your TestRail email
API Token	Generated from user settings
Base URL	TestRail instance URL (e.g., `https://yourcompany.testrail.io`)

Info: Setup access in TestRail. These steps require Administrator, or a colleague with equivalent permissions who can create credentials for you. If that is not you, ask your TestRail administrator.

TestRail user account with API access enabled
Admin access for full data visibility

Step 1: Access User Settings

Log in to TestRail
Click your name in the top right → My Settings

Step 2: Enable API Key

Go to the API Keys section
Check Enable API if not already enabled
Click Add Key or Generate Key
Name: Parable Integration

Warning: Copy your API key now! This is the only time it will be displayed. Store it in a secure password manager before closing this page.

Step 3: Note Instance URL

Your TestRail URL format:

https://yourcompany.testrail.io

Step 4: Enter values in the form

Enter your TestRail URL, Email, and API Key in the Provider form.
Click Save & test connection.

Test Authentication

curl -u "your-email:YOUR_API_KEY" \
  "https://yourcompany.testrail.io/index.php?/api/v2/get_user_by_email&email=your-email"

List Projects

curl -u "your-email:YOUR_API_KEY" \
  "https://yourcompany.testrail.io/index.php?/api/v2/get_projects"

Success: Success! If you received a 200 OK response with valid data, your credentials are configured correctly. You can now configure this Provider in Parable.

Tip: Rate Limits: TestRail enforces rate limits of varies by plan; typically 200 requests/minute. Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.

Cases

Developer identifier: casesCases contain test cases for a project/suite combination.

Enables: review test-case definitions, ownership context, priority, and automation metadata.
Scope: Reads the declared collection through GET /index.php?/api/v2/get_cases/{project_id} as a full snapshot. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Provider-defined fields may also be returned for this data stream.

Created By

Developer identifier: cases.created_byCreated By identifies the TestRail user who created the case. It preserves the user relationship behind case authorship.

Enables: join cases to their creating users for ownership and audit analysis.
Interpretation: The provider supplies created_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Created On

Developer identifier: cases.created_onCreated On records unix timestamp when the case was created. It anchors the named event or boundary on the record’s timeline.

Enables: place case records on a timeline by created on and select the records within an explicit reporting window.
Interpretation: The provider supplies created_on per test rail case record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Custom Automation Type

Developer identifier: cases.custom_automation_typeCustom Automation Type records custom field: automation type ID (e.g., 0 = None, 1 = Ranorex). It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom automation type according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_automation_type can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Expected

Developer identifier: cases.custom_expectedCustom Expected records custom field: expected result in text format. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom expected according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_expected can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Goals

Developer identifier: cases.custom_goalsCustom Goals records custom field: goals for the test case. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom goals according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_goals can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Mission

Developer identifier: cases.custom_missionCustom Mission records custom field: mission or charter for exploratory testing. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom mission according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_mission can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Obsolete

Developer identifier: cases.custom_obsoleteCustom Obsolete records custom field: whether the test case is marked as obsolete. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom obsolete according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_obsolete can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Preconds

Developer identifier: cases.custom_precondsCustom Preconds records custom field: preconditions for the test case (markdown/text). It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom preconds according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_preconds can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Steps

Developer identifier: cases.custom_stepsCustom Steps records custom field: test steps in text format. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom steps according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_steps can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Steps Separated

Developer identifier: cases.custom_steps_separatedCustom Steps Separated records custom field: test steps as structured separated steps. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom steps separated according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_steps_separated can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Additional Info

Developer identifier: cases.custom_steps_separated.additional_infoAdditional Info records additional information or notes for this step. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact additional info value attached to each test rail case step record.
Interpretation: The provider supplies additional_info at test rail case step granularity in the format stated by its description; omitted or redacted content remains unknown.

Content

Developer identifier: cases.custom_steps_separated.contentContent captures the step description or action to perform. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact content value attached to each test rail case step record.
Interpretation: The provider supplies content at test rail case step granularity in the format stated by its description; omitted or redacted content remains unknown.

Expected

Developer identifier: cases.custom_steps_separated.expectedExpected captures the expected result after performing this step. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact expected value attached to each test rail case step record.
Interpretation: The provider supplies expected at test rail case step granularity in the format stated by its description; omitted or redacted content remains unknown.

Refs

Developer identifier: cases.custom_steps_separated.refsRefs records reference IDs associated with this step. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by refs from the test record to their external records.
Interpretation: The provider supplies refs as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Shared Step ID

Developer identifier: cases.custom_steps_separated.shared_step_idShared Step ID is the ID of a shared step definition if this step references one. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same shared step ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies shared_step_id as a record-level identifier on TestRailCaseStep. It is not a uniqueness guarantee unless a connector directive says so.

Custom Tags

Developer identifier: cases.custom_tagsCustom Tags records custom field: tags or labels associated with the test case. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom tags according to the provider and Workspace configuration that produced each case record.
Interpretation: Keys and value shapes within custom_tags can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Display Order

Developer identifier: cases.display_orderDisplay Order reports display order of the case within its section. It preserves the stated measure at this record’s granularity.

Enables: order or classify case records using the provider-defined display order value.
Interpretation: The provider supplies display_order at test rail case granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Estimate

Developer identifier: cases.estimateEstimate records the planned execution duration for the test case. It preserves TestRail’s human-readable duration text.

Enables: compare planned effort across cases and schedule test execution using the recorded estimate.
Interpretation: The provider supplies estimate as duration text such as 30s, 1m 45s, or 2h; parse TestRail’s units rather than treating the string as an ordinal.

Estimate Forecast

Developer identifier: cases.estimate_forecastEstimate Forecast records the execution duration forecast from historical test results. It preserves TestRail’s predicted duration text for the case.

Enables: compare forecasted execution effort with the authored estimate and plan test capacity.
Interpretation: The provider supplies estimate_forecast as a provider-formatted duration, not an ordinal or sequence; missing means no forecast was reported.

Developer identifier: cases.idID is the unique test case identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail case source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail case record, and x-transformDedupKey explicitly marks it as the record key.

Is Deleted

Developer identifier: cases.is_deletedIs Deleted indicates whether the case has been soft-deleted. 0 = active, 1 = deleted. It preserves the provider’s current classification of this record.

Enables: separate case records by the exact provider-reported is deleted value when describing their recorded state.
Interpretation: The provider supplies is_deleted per test rail case record using its own state vocabulary; unknown and missing values must remain distinct.

Milestone ID

Developer identifier: cases.milestone_idMilestone ID is the ID of the associated milestone for timeline analysis. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same milestone ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies milestone_id as a record-level identifier on TestRailCase. It is not a uniqueness guarantee unless a connector directive says so.

Priority ID

Developer identifier: cases.priority_idPriority ID is the ID of the case priority, indicating test importance. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same priority ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies priority_id as a record-level identifier on TestRailCase. It is not a uniqueness guarantee unless a connector directive says so.

Project ID

Developer identifier: cases.project_idProject ID identifies parent key injected by the ingestor from the suites to cases traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies project_id as a record-level identifier on TestRailCase. It is not a uniqueness guarantee unless a connector directive says so.

Refs

Developer identifier: cases.refsRefs records comma-separated reference IDs linking to external systems such as issue trackers. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by refs from the test record to their external records.
Interpretation: The provider supplies refs as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Section ID

Developer identifier: cases.section_idSection ID is the ID of the section (folder) this case belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same section ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies section_id as a record-level identifier on TestRailCase. It is not a uniqueness guarantee unless a connector directive says so.

Suite ID

Developer identifier: cases.suite_idSuite ID is the ID of the suite this case belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same suite ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies suite_id as a record-level identifier on TestRailCase. It is not a uniqueness guarantee unless a connector directive says so.

Template ID

Developer identifier: cases.template_idTemplate ID is the ID of the template used for this case. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same template ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies template_id as a record-level identifier on TestRailCase. It is not a uniqueness guarantee unless a connector directive says so.

Title

Developer identifier: cases.titleTitle records title of the test case describing the test being performed. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact title value attached to each test rail case record.
Interpretation: The provider supplies title at test rail case granularity in the format stated by its description; omitted or redacted content remains unknown.

Type ID

Developer identifier: cases.type_idType ID is the ID of the case type, categorizing the kind of test. It is needed to resolve references that repeat the same provider identifier.

Enables: match case records to provider records that carry the same type ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies type_id as a record-level identifier on TestRailCase. It is not a uniqueness guarantee unless a connector directive says so.

Updated By

Developer identifier: cases.updated_byUpdated By identifies the TestRail user who last updated the case. It preserves the user relationship behind the latest recorded change.

Enables: join cases to their last-updating users for change and audit analysis.
Interpretation: The provider supplies updated_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Updated On

Developer identifier: cases.updated_onUpdated On records unix timestamp when the case was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place case records on a timeline by updated on and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_on per test rail case record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Plans

Developer identifier: plansPlans contain test plans for a project.

Enables: review planned test runs and their recorded milestones and status.
Scope: Reads the declared collection through GET /index.php?/api/v2/get_plans/{id} as a full snapshot. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Assignedto ID

Developer identifier: plans.assignedto_idAssignedto ID identifies user ID assigned to the plan. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same assignedto ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies assignedto_id as a record-level identifier on TestRailPlan. It is not a uniqueness guarantee unless a connector directive says so.

Blocked Count

Developer identifier: plans.blocked_countBlocked Count reports the number of blocked tests across all runs in the plan. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported blocked count for each test rail plan record.
Interpretation: The provider supplies blocked_count at test rail plan granularity as a count at one value per record; zero and missing are not interchangeable.

Completed On

Developer identifier: plans.completed_onCompleted On states unix timestamp when the plan was completed. It preserves the provider’s current classification of this record.

Enables: separate plan records by the exact provider-reported completed on value when describing their recorded state.
Interpretation: The provider supplies completed_on per test rail plan record using its own state vocabulary; unknown and missing values must remain distinct.

Created By

Developer identifier: plans.created_byCreated By identifies the TestRail user who created the plan. It preserves the user relationship behind plan authorship.

Enables: join plans to their creating users for ownership and audit analysis.
Interpretation: The provider supplies created_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Created On

Developer identifier: plans.created_onCreated On records unix timestamp when the plan was created. It anchors the named event or boundary on the record’s timeline.

Enables: place plan records on a timeline by created on and select the records within an explicit reporting window.
Interpretation: The provider supplies created_on per test rail plan record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Custom Status1 Count

Developer identifier: plans.custom_status1_countCustom Status1 Count reports the number of tests with custom status 1 across all runs in the plan. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status1 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status1_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status2 Count

Developer identifier: plans.custom_status2_countCustom Status2 Count reports the number of tests with custom status 2 across all runs in the plan. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status2 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status2_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status3 Count

Developer identifier: plans.custom_status3_countCustom Status3 Count reports the number of tests with custom status 3 across all runs in the plan. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status3 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status3_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status4 Count

Developer identifier: plans.custom_status4_countCustom Status4 Count reports the number of tests with custom status 4 across all runs in the plan. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status4 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status4_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status5 Count

Developer identifier: plans.custom_status5_countCustom Status5 Count reports the number of tests with custom status 5 across all runs in the plan. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status5 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status5_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status6 Count

Developer identifier: plans.custom_status6_countCustom Status6 Count reports the number of tests with custom status 6 across all runs in the plan. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status6 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status6_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status7 Count

Developer identifier: plans.custom_status7_countCustom Status7 Count reports the number of tests with custom status 7 across all runs in the plan. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status7 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status7_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Description

Developer identifier: plans.descriptionDescription records description of the plan, providing context for its purpose. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description value attached to each test rail plan record.
Interpretation: The provider supplies description at test rail plan granularity in the format stated by its description; omitted or redacted content remains unknown.

Entries

Developer identifier: plans.entriesEntries records array of plan entries (test run groups), included when retrieving a single plan via get_plan. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: enumerate the nested entries records contained by each test rail plan record.
Interpretation: The provider returns entries as a list on TestRailPlan; an absent value does not prove that no related object exists outside the credential’s visibility.

Assignedto ID

Developer identifier: plans.entries.assignedto_idAssignedto ID identifies user ID assigned to this entry. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same assignedto ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies assignedto_id as a record-level identifier on TestRailPlanEntry. It is not a uniqueness guarantee unless a connector directive says so.

Case IDs

Developer identifier: plans.entries.case_idsCase IDs identifies array of specific case IDs included in this entry when include_all is false. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same case ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies case_ids as a record-level identifier on TestRailPlanEntry. It is not a uniqueness guarantee unless a connector directive says so.

Config IDs

Developer identifier: plans.entries.config_idsConfig IDs identifies array of configuration IDs applied to this entry. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same config ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies config_ids as a record-level identifier on TestRailPlanEntry. It is not a uniqueness guarantee unless a connector directive says so.

Description

Developer identifier: plans.entries.descriptionDescription records description of the plan entry. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description value attached to each test rail plan entry record.
Interpretation: The provider supplies description at test rail plan entry granularity in the format stated by its description; omitted or redacted content remains unknown.

Developer identifier: plans.entries.idID is the unique identifier for the plan entry (UUID string). It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail plan entry source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail plan entry record, and x-transformDedupKey explicitly marks it as the record key.

Include All

Developer identifier: plans.entries.include_allInclude All indicates whether all test cases from the suite are included. It preserves the provider-reported yes-or-no condition for this record.

Enables: select plan records for which the provider reports include all as true or false.
Interpretation: The provider supplies include_all as a boolean per test rail plan entry record; false and missing are distinct when the field is optional.

Name

Developer identifier: plans.entries.nameName records name of the plan entry. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each test rail plan entry record.
Interpretation: The provider supplies name at test rail plan entry granularity in the format stated by its description; omitted or redacted content remains unknown.

Refs

Developer identifier: plans.entries.refsRefs records comma-separated list of references or requirements. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by refs from the test record to their external records.
Interpretation: The provider supplies refs as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Runs

Developer identifier: plans.entries.runsRuns records array of test runs within this plan entry. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: enumerate the nested runs records contained by each test rail plan entry record.
Interpretation: The provider returns runs as a list on TestRailPlanEntry; an absent value does not prove that no related object exists outside the credential’s visibility.

Assignedto ID

Developer identifier: plans.entries.runs.assignedto_idAssignedto ID identifies user ID assigned to this run. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same assignedto ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies assignedto_id as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Blocked Count

Developer identifier: plans.entries.runs.blocked_countBlocked Count reports the number of blocked tests in this run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported blocked count for each test rail plan entry run record.
Interpretation: The provider supplies blocked_count at test rail plan entry run granularity as a count at one value per record; zero and missing are not interchangeable.

Case IDs

Developer identifier: plans.entries.runs.case_idsCase IDs identifies array of specific case IDs included in this run. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same case ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies case_ids as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Completed On

Developer identifier: plans.entries.runs.completed_onCompleted On states unix timestamp when the run was completed. It preserves the provider’s current classification of this record.

Enables: separate plan records by the exact provider-reported completed on value when describing their recorded state.
Interpretation: The provider supplies completed_on per test rail plan entry run record using its own state vocabulary; unknown and missing values must remain distinct.

Config

Developer identifier: plans.entries.runs.configConfig records comma-separated configuration names applied to this run. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact config when validating the configuration or technical definition of a test rail plan entry run record.
Interpretation: The provider supplies config as configuration or technical metadata on TestRailPlanEntryRun; consumers must preserve the exact syntax and documented vocabulary.

Config IDs

Developer identifier: plans.entries.runs.config_idsConfig IDs identifies array of configuration IDs applied to this run. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same config ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies config_ids as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Created By

Developer identifier: plans.entries.runs.created_byCreated By identifies the TestRail user who created the plan-entry run. It preserves the user relationship behind run creation.

Enables: join plan-entry runs to their creating users for ownership and audit analysis.
Interpretation: The provider supplies created_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Created On

Developer identifier: plans.entries.runs.created_onCreated On records unix timestamp when the run was created. It anchors the named event or boundary on the record’s timeline.

Enables: place plan records on a timeline by created on and select the records within an explicit reporting window.
Interpretation: The provider supplies created_on per test rail plan entry run record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Custom Status1 Count

Developer identifier: plans.entries.runs.custom_status1_countCustom Status1 Count reports the number of tests with custom status 1 in this run. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status1 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status1_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status2 Count

Developer identifier: plans.entries.runs.custom_status2_countCustom Status2 Count reports the number of tests with custom status 2 in this run. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status2 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status2_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status3 Count

Developer identifier: plans.entries.runs.custom_status3_countCustom Status3 Count reports the number of tests with custom status 3 in this run. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status3 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status3_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status4 Count

Developer identifier: plans.entries.runs.custom_status4_countCustom Status4 Count reports the number of tests with custom status 4 in this run. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status4 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status4_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status5 Count

Developer identifier: plans.entries.runs.custom_status5_countCustom Status5 Count reports the number of tests with custom status 5 in this run. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status5 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status5_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status6 Count

Developer identifier: plans.entries.runs.custom_status6_countCustom Status6 Count reports the number of tests with custom status 6 in this run. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status6 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status6_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status7 Count

Developer identifier: plans.entries.runs.custom_status7_countCustom Status7 Count reports the number of tests with custom status 7 in this run. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status7 count according to the provider and Workspace configuration that produced each plan record.
Interpretation: Keys and value shapes within custom_status7_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Description

Developer identifier: plans.entries.runs.descriptionDescription records description of the run. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description value attached to each test rail plan entry run record.
Interpretation: The provider supplies description at test rail plan entry run granularity in the format stated by its description; omitted or redacted content remains unknown.

Entry ID

Developer identifier: plans.entries.runs.entry_idEntry ID is the ID of the plan entry this run belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same entry ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies entry_id as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Entry Index

Developer identifier: plans.entries.runs.entry_indexEntry Index reports index of the plan entry this run belongs to. It preserves the stated measure at this record’s granularity.

Enables: order or classify plan records using the provider-defined entry index value.
Interpretation: The provider supplies entry_index at test rail plan entry run granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Failed Count

Developer identifier: plans.entries.runs.failed_countFailed Count reports the number of failed tests in this run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported failed count for each test rail plan entry run record.
Interpretation: The provider supplies failed_count at test rail plan entry run granularity as a count at one value per record; zero and missing are not interchangeable.

Developer identifier: plans.entries.runs.idID is the unique run identifier. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Include All

Developer identifier: plans.entries.runs.include_allInclude All indicates whether all test cases from the suite are included. It preserves the provider-reported yes-or-no condition for this record.

Enables: select plan records for which the provider reports include all as true or false.
Interpretation: The provider supplies include_all as a boolean per test rail plan entry run record; false and missing are distinct when the field is optional.

Is Completed

Developer identifier: plans.entries.runs.is_completedIs Completed indicates whether the run is completed. It preserves the provider-reported yes-or-no condition for this record.

Enables: select plan records for which the provider reports is completed as true or false.
Interpretation: The provider supplies is_completed as a boolean per test rail plan entry run record; false and missing are distinct when the field is optional.

Milestone ID

Developer identifier: plans.entries.runs.milestone_idMilestone ID is the ID of the associated milestone. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same milestone ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies milestone_id as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: plans.entries.runs.nameName records name of the test run. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each test rail plan entry run record.
Interpretation: The provider supplies name at test rail plan entry run granularity in the format stated by its description; omitted or redacted content remains unknown.

Passed Count

Developer identifier: plans.entries.runs.passed_countPassed Count reports the number of passed tests in this run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported passed count for each test rail plan entry run record.
Interpretation: The provider supplies passed_count at test rail plan entry run granularity as a count at one value per record; zero and missing are not interchangeable.

Plan ID

Developer identifier: plans.entries.runs.plan_idPlan ID is the ID of the parent plan. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same plan ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies plan_id as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Project ID

Developer identifier: plans.entries.runs.project_idProject ID is the ID of the parent project. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies project_id as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Refs

Developer identifier: plans.entries.runs.refsRefs records comma-separated list of references or requirements. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by refs from the test record to their external records.
Interpretation: The provider supplies refs as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Retest Count

Developer identifier: plans.entries.runs.retest_countRetest Count reports the number of tests marked for retest in this run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported retest count for each test rail plan entry run record.
Interpretation: The provider supplies retest_count at test rail plan entry run granularity as a count at one value per record; zero and missing are not interchangeable.

Suite ID

Developer identifier: plans.entries.runs.suite_idSuite ID is the ID of the test suite for this run. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same suite ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies suite_id as a record-level identifier on TestRailPlanEntryRun. It is not a uniqueness guarantee unless a connector directive says so.

Untested Count

Developer identifier: plans.entries.runs.untested_countUntested Count reports the number of untested tests in this run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported untested count for each test rail plan entry run record.
Interpretation: The provider supplies untested_count at test rail plan entry run granularity as a count at one value per record; zero and missing are not interchangeable.

Updated On

Developer identifier: plans.entries.runs.updated_onUpdated On records unix timestamp when the run was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place plan records on a timeline by updated on and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_on per test rail plan entry run record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

URL

Developer identifier: plans.entries.runs.urlURL records URL to the run in TestRail. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by URL on a test rail plan entry run record.
Interpretation: The provider supplies url as a URL or resource locator on each test rail plan entry run record. Availability still follows the provider’s permissions and retention.

Suite ID

Developer identifier: plans.entries.suite_idSuite ID is the ID of the test suite associated with this entry. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same suite ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies suite_id as a record-level identifier on TestRailPlanEntry. It is not a uniqueness guarantee unless a connector directive says so.

Failed Count

Developer identifier: plans.failed_countFailed Count reports the number of failed tests across all runs in the plan. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported failed count for each test rail plan record.
Interpretation: The provider supplies failed_count at test rail plan granularity as a count at one value per record; zero and missing are not interchangeable.

Developer identifier: plans.idID is the unique plan identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail plan source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail plan record, and x-transformDedupKey explicitly marks it as the record key.

Is Completed

Developer identifier: plans.is_completedIs Completed indicates whether the plan is completed. It preserves the provider-reported yes-or-no condition for this record.

Enables: select plan records for which the provider reports is completed as true or false.
Interpretation: The provider supplies is_completed as a boolean per test rail plan record; false and missing are distinct when the field is optional.

Milestone ID

Developer identifier: plans.milestone_idMilestone ID is the ID of the associated milestone. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same milestone ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies milestone_id as a record-level identifier on TestRailPlan. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: plans.nameName records name of the test plan. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each test rail plan record.
Interpretation: The provider supplies name at test rail plan granularity in the format stated by its description; omitted or redacted content remains unknown.

Passed Count

Developer identifier: plans.passed_countPassed Count reports the number of passed tests across all runs in the plan. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported passed count for each test rail plan record.
Interpretation: The provider supplies passed_count at test rail plan granularity as a count at one value per record; zero and missing are not interchangeable.

Project ID

Developer identifier: plans.project_idProject ID is the ID of the parent project. It is needed to resolve references that repeat the same provider identifier.

Enables: match plan records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies project_id as a record-level identifier on TestRailPlan. It is not a uniqueness guarantee unless a connector directive says so.

Retest Count

Developer identifier: plans.retest_countRetest Count reports the number of tests marked for retest across all runs in the plan. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported retest count for each test rail plan record.
Interpretation: The provider supplies retest_count at test rail plan granularity as a count at one value per record; zero and missing are not interchangeable.

Untested Count

Developer identifier: plans.untested_countUntested Count reports the number of untested tests across all runs in the plan. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported untested count for each test rail plan record.
Interpretation: The provider supplies untested_count at test rail plan granularity as a count at one value per record; zero and missing are not interchangeable.

Updated On

Developer identifier: plans.updated_onUpdated On records unix timestamp when the plan was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place plan records on a timeline by updated on and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_on per test rail plan record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

URL

Developer identifier: plans.urlURL records URL to the plan in TestRail. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by URL on a test rail plan record.
Interpretation: The provider supplies url as a URL or resource locator on each test rail plan record. Availability still follows the provider’s permissions and retention.

Projects

Developer identifier: projectsProjects contain all TestRail projects.

Enables: enumerate TestRail project containers before loading their suites, cases, plans, and runs.
Scope: Reads the declared collection through GET /index.php?/api/v2/get_projects as a full snapshot. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Announcement

Developer identifier: projects.announcementAnnouncement states project announcement text, typically used to communicate project status or goals. It preserves the provider’s current classification of this record.

Enables: separate project records by the exact provider-reported announcement value when describing their recorded state.
Interpretation: The provider supplies announcement per test rail project record using its own state vocabulary; unknown and missing values must remain distinct.

Completed On

Developer identifier: projects.completed_onCompleted On states unix timestamp when the project was completed. Null if not completed. It preserves the provider’s current classification of this record.

Enables: separate project records by the exact provider-reported completed on value when describing their recorded state.
Interpretation: The provider supplies completed_on per test rail project record using its own state vocabulary; unknown and missing values must remain distinct.

Default Role

Developer identifier: projects.default_roleDefault Role captures the name of the default role assigned to users added to this project. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported default role attached to each test rail project record.
Interpretation: The provider supplies default_role at test rail project granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Default Role ID

Developer identifier: projects.default_role_idDefault Role ID captures the default role ID assigned to users added to this project. It is needed to resolve references that repeat the same provider identifier.

Enables: match project records to provider records that carry the same default role ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies default_role_id as a record-level identifier on TestRailProject. It is not a uniqueness guarantee unless a connector directive says so.

Groups

Developer identifier: projects.groupsGroups records list of group objects associated with the project, if included in the response. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: associate each test rail project record with the specific provider container named by groups.
Interpretation: The provider returns groups as a list on TestRailProject; an absent value does not prove that no related object exists outside the credential’s visibility.

Developer identifier: projects.groups.idID is the unique group identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail project group source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail project group record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: projects.groups.nameName records name of the group. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each test rail project group record.
Interpretation: The provider supplies name at test rail project group granularity in the format stated by its description; omitted or redacted content remains unknown.

Role

Developer identifier: projects.groups.roleRole captures the name of the role assigned to the group within this project. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported role attached to each test rail project group record.
Interpretation: The provider supplies role at test rail project group granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Role ID

Developer identifier: projects.groups.role_idRole ID captures the role ID assigned to the group within this project. It is needed to resolve references that repeat the same provider identifier.

Enables: match project records to provider records that carry the same role ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies role_id as a record-level identifier on TestRailProjectGroup. It is not a uniqueness guarantee unless a connector directive says so.

Developer identifier: projects.idID is the unique project identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail project source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail project record, and x-transformDedupKey explicitly marks it as the record key.

Is Completed

Developer identifier: projects.is_completedIs Completed indicates whether the project is marked as completed (archived). It preserves the provider-reported yes-or-no condition for this record.

Enables: select project records for which the provider reports is completed as true or false.
Interpretation: The provider supplies is_completed as a boolean per test rail project record; false and missing are distinct when the field is optional.

Is Deleted

Developer identifier: projects.is_deletedIs Deleted indicates whether the project has been soft-deleted. It preserves the provider-reported yes-or-no condition for this record.

Enables: select project records for which the provider reports is deleted as true or false.
Interpretation: The provider supplies is_deleted as a boolean per test rail project record; false and missing are distinct when the field is optional.

Name

Developer identifier: projects.nameName records name of the project. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each test rail project record.
Interpretation: The provider supplies name at test rail project granularity in the format stated by its description; omitted or redacted content remains unknown.

Show Announcement

Developer identifier: projects.show_announcementShow Announcement indicates whether the project announcement is displayed on the project overview page. It preserves the provider-reported yes-or-no condition for this record.

Enables: select project records for which the provider reports show announcement as true or false.
Interpretation: The provider supplies show_announcement as a boolean per test rail project record; false and missing are distinct when the field is optional.

Suite Mode

Developer identifier: projects.suite_modeSuite Mode states suite mode of the project determining how suites and sections are organized. It preserves the provider’s current classification of this record.

Enables: separate project records by the exact provider-reported suite mode value when describing their recorded state.
Interpretation: The provider supplies suite_mode per test rail project record using its own state vocabulary; unknown and missing values must remain distinct.

URL

Developer identifier: projects.urlURL records URL to the project in the TestRail web interface. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by URL on a test rail project record.
Interpretation: The provider supplies url as a URL or resource locator on each test rail project record. Availability still follows the provider’s permissions and retention.

Users

Developer identifier: projects.usersUsers records list of user objects associated with the project, if included in the response. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the test rail project record to the provider-reported actor represented by users.
Interpretation: The provider supplies users as identity or attribution context on each test rail project record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: projects.users.emailEmail records email address of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the test rail project user record to the provider-reported person or account represented by email.
Interpretation: The provider supplies email as identity or attribution context on each test rail project user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: projects.users.idID is the unique user identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail project user source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail project user record, and x-transformDedupKey explicitly marks it as the record key.

Is Active

Developer identifier: projects.users.is_activeIs Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.

Enables: select project records for which the provider reports is active as true or false.
Interpretation: The provider supplies is_active as a boolean per test rail project user record; false and missing are distinct when the field is optional.

Name

Developer identifier: projects.users.nameName records full name of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the test rail project user record to the provider-reported person or account represented by name.
Interpretation: The provider supplies name as identity or attribution context on each test rail project user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Role

Developer identifier: projects.users.roleRole captures the name of the role assigned to the user within this project. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported role attached to each test rail project user record.
Interpretation: The provider supplies role at test rail project user granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Role ID

Developer identifier: projects.users.role_idRole ID captures the role ID assigned to the user within this project. It is needed to resolve references that repeat the same provider identifier.

Enables: match project records to provider records that carry the same role ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies role_id as a record-level identifier on TestRailProjectUser. It is not a uniqueness guarantee unless a connector directive says so.

Results

Developer identifier: resultsResults contain test results for a run.

Enables: measure recorded test outcomes and elapsed time for each run.
Scope: Reads provider changes through GET /index.php?/api/v2/get_results_for_run/{id} using the declared incremental request boundary. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Provider-defined fields may also be returned for this data stream.

Assignedto ID

Developer identifier: results.assignedto_idAssignedto ID identifies user ID assigned to the test at the time of this result. It is needed to resolve references that repeat the same provider identifier.

Enables: match result records to provider records that carry the same assignedto ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies assignedto_id as a record-level identifier on TestRailResult. It is not a uniqueness guarantee unless a connector directive says so.

Attachment IDs

Developer identifier: results.attachment_idsAttachment IDs identifies array of attachment IDs associated with this result. It is needed to resolve references that repeat the same provider identifier.

Enables: match result records to provider records that carry the same attachment ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies attachment_ids as a record-level identifier on TestRailResult. It is not a uniqueness guarantee unless a connector directive says so.

Comment

Developer identifier: results.commentComment records comment or notes on the result, may contain rich text/markdown. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact comment value attached to each test rail result record.
Interpretation: The provider supplies comment at test rail result granularity in the format stated by its description; omitted or redacted content remains unknown.

Created By

Developer identifier: results.created_byCreated By identifies the TestRail user who created or submitted the result. It preserves the user relationship behind the recorded outcome.

Enables: join results to their submitting users for execution and audit analysis.
Interpretation: The provider supplies created_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Created On

Developer identifier: results.created_onCreated On records unix timestamp when the result was created. It anchors the named event or boundary on the record’s timeline.

Enables: place result records on a timeline by created on and select the records within an explicit reporting window.
Interpretation: The provider supplies created_on per test rail result record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Custom Step Results

Developer identifier: results.custom_step_resultsCustom Step Results records array of individual step results for step-based test cases. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom step results according to the provider and Workspace configuration that produced each result record.
Interpretation: Keys and value shapes within custom_step_results can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Actual

Developer identifier: results.custom_step_results.actualActual captures the actual result observed during execution. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact actual value attached to each custom step result record.
Interpretation: The provider supplies actual at custom step result granularity in the format stated by its description; omitted or redacted content remains unknown.

Content

Developer identifier: results.custom_step_results.contentContent captures the step description/content. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact content value attached to each custom step result record.
Interpretation: The provider supplies content at custom step result granularity in the format stated by its description; omitted or redacted content remains unknown.

Expected

Developer identifier: results.custom_step_results.expectedExpected captures the expected result for this step. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact expected value attached to each custom step result record.
Interpretation: The provider supplies expected at custom step result granularity in the format stated by its description; omitted or redacted content remains unknown.

Status ID

Developer identifier: results.custom_step_results.status_idStatus ID identifies status of this individual step (e.g., 1=Passed, 5=Failed). It is needed to resolve references that repeat the same provider identifier.

Enables: match result records to provider records that carry the same status ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies status_id as a record-level identifier on CustomStepResult. It is not a uniqueness guarantee unless a connector directive says so.

Defects

Developer identifier: results.defectsDefects records comma-separated list of defect/bug IDs linked to this result. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by defects from the test record to their external records.
Interpretation: The provider supplies defects as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Elapsed

Developer identifier: results.elapsedElapsed reports time elapsed for the test execution (e.g., ’30s’, ‘1m 45s’, ‘2h 30m’). It preserves the elapsed interval reported for this record.

Enables: compare the provider-recorded interval represented by elapsed across result records.
Interpretation: The provider supplies elapsed per test rail result record in the unit stated by the provider description; it is an elapsed or recorded interval, not an outcome measure.

Developer identifier: results.idID is the unique result identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail result source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail result record, and x-transformDedupKey explicitly marks it as the record key.

Status ID

Developer identifier: results.status_idStatus ID identifies status of the result (e.g., 1=Passed, 2=Blocked, 3=Untested, 4=Retest, 5=Failed). It is needed to resolve references that repeat the same provider identifier.

Enables: match result records to provider records that carry the same status ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies status_id as a record-level identifier on TestRailResult. It is not a uniqueness guarantee unless a connector directive says so.

Test ID

Developer identifier: results.test_idTest ID is the ID of the parent test this result belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match result records to provider records that carry the same test ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies test_id as a record-level identifier on TestRailResult. It is not a uniqueness guarantee unless a connector directive says so.

Version

Developer identifier: results.versionVersion identifies version or build identifier of the software being tested. It is needed to resolve references that repeat the same provider identifier.

Enables: match result records to provider records that carry the same version, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies version as a record-level identifier on TestRailResult. It is not a uniqueness guarantee unless a connector directive says so.

Runs

Developer identifier: runsRuns contain test runs for a project.

Enables: compare test runs by configuration, milestone, assignee context, and completion state.
Scope: Reads the declared collection through GET /index.php?/api/v2/get_runs/{id} as a full snapshot. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Assignedto ID

Developer identifier: runs.assignedto_idAssignedto ID identifies user ID assigned to the run. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same assignedto ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies assignedto_id as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Blocked Count

Developer identifier: runs.blocked_countBlocked Count reports the number of blocked tests in the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported blocked count for each test rail run record.
Interpretation: The provider supplies blocked_count at test rail run granularity as a count at one value per record; zero and missing are not interchangeable.

Case IDs

Developer identifier: runs.case_idsCase IDs identifies array of case IDs included in the run when include_all is false. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same case ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies case_ids as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Completed On

Developer identifier: runs.completed_onCompleted On states unix timestamp when the run was completed. Null if not completed. It preserves the provider’s current classification of this record.

Enables: separate run records by the exact provider-reported completed on value when describing their recorded state.
Interpretation: The provider supplies completed_on per test rail run record using its own state vocabulary; unknown and missing values must remain distinct.

Config

Developer identifier: runs.configConfig records configuration string for the run, describing the test configuration context. It preserves the configuration or technical value needed to explain how the provider object is defined.

Enables: inspect the exact config when validating the configuration or technical definition of a test rail run record.
Interpretation: The provider supplies config as configuration or technical metadata on TestRailRun; consumers must preserve the exact syntax and documented vocabulary.

Config IDs

Developer identifier: runs.config_idsConfig IDs identifies array of configuration IDs associated with the run. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same config ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies config_ids as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Created By

Developer identifier: runs.created_byCreated By identifies the TestRail user who created the run. It preserves the user relationship behind run creation.

Enables: join runs to their creating users for ownership and audit analysis.
Interpretation: The provider supplies created_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Created On

Developer identifier: runs.created_onCreated On records unix timestamp when the run was created. It anchors the named event or boundary on the record’s timeline.

Enables: place run records on a timeline by created on and select the records within an explicit reporting window.
Interpretation: The provider supplies created_on per test rail run record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Custom Status1 Count

Developer identifier: runs.custom_status1_countCustom Status1 Count reports the number of tests with custom status 1. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status1 count according to the provider and Workspace configuration that produced each run record.
Interpretation: Keys and value shapes within custom_status1_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status2 Count

Developer identifier: runs.custom_status2_countCustom Status2 Count reports the number of tests with custom status 2. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status2 count according to the provider and Workspace configuration that produced each run record.
Interpretation: Keys and value shapes within custom_status2_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status3 Count

Developer identifier: runs.custom_status3_countCustom Status3 Count reports the number of tests with custom status 3. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status3 count according to the provider and Workspace configuration that produced each run record.
Interpretation: Keys and value shapes within custom_status3_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status4 Count

Developer identifier: runs.custom_status4_countCustom Status4 Count reports the number of tests with custom status 4. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status4 count according to the provider and Workspace configuration that produced each run record.
Interpretation: Keys and value shapes within custom_status4_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status5 Count

Developer identifier: runs.custom_status5_countCustom Status5 Count reports the number of tests with custom status 5. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status5 count according to the provider and Workspace configuration that produced each run record.
Interpretation: Keys and value shapes within custom_status5_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status6 Count

Developer identifier: runs.custom_status6_countCustom Status6 Count reports the number of tests with custom status 6. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status6 count according to the provider and Workspace configuration that produced each run record.
Interpretation: Keys and value shapes within custom_status6_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Status7 Count

Developer identifier: runs.custom_status7_countCustom Status7 Count reports the number of tests with custom status 7. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom status7 count according to the provider and Workspace configuration that produced each run record.
Interpretation: Keys and value shapes within custom_status7_count can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Description

Developer identifier: runs.descriptionDescription records description of the run providing context for its purpose. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description value attached to each test rail run record.
Interpretation: The provider supplies description at test rail run granularity in the format stated by its description; omitted or redacted content remains unknown.

Entry ID

Developer identifier: runs.entry_idEntry ID is the ID of the test plan entry this run belongs to, if part of a plan. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same entry ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies entry_id as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Entry Index

Developer identifier: runs.entry_indexEntry Index reports index of the test plan entry this run belongs to, if part of a plan. It preserves the stated measure at this record’s granularity.

Enables: order or classify run records using the provider-defined entry index value.
Interpretation: The provider supplies entry_index at test rail run granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Failed Count

Developer identifier: runs.failed_countFailed Count reports the number of failed tests in the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported failed count for each test rail run record.
Interpretation: The provider supplies failed_count at test rail run granularity as a count at one value per record; zero and missing are not interchangeable.

Developer identifier: runs.idID is the unique run identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail run source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail run record, and x-transformDedupKey explicitly marks it as the record key.

Include All

Developer identifier: runs.include_allInclude All indicates whether the run includes all test cases from the suite. It preserves the provider-reported yes-or-no condition for this record.

Enables: select run records for which the provider reports include all as true or false.
Interpretation: The provider supplies include_all as a boolean per test rail run record; false and missing are distinct when the field is optional.

Is Completed

Developer identifier: runs.is_completedIs Completed indicates whether the run is completed. It preserves the provider-reported yes-or-no condition for this record.

Enables: select run records for which the provider reports is completed as true or false.
Interpretation: The provider supplies is_completed as a boolean per test rail run record; false and missing are distinct when the field is optional.

Milestone ID

Developer identifier: runs.milestone_idMilestone ID is the ID of the associated milestone. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same milestone ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies milestone_id as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: runs.nameName records name of the test run. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each test rail run record.
Interpretation: The provider supplies name at test rail run granularity in the format stated by its description; omitted or redacted content remains unknown.

Passed Count

Developer identifier: runs.passed_countPassed Count reports the number of passed tests in the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported passed count for each test rail run record.
Interpretation: The provider supplies passed_count at test rail run granularity as a count at one value per record; zero and missing are not interchangeable.

Plan ID

Developer identifier: runs.plan_idPlan ID is the ID of the parent test plan, if any. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same plan ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies plan_id as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Project ID

Developer identifier: runs.project_idProject ID is the ID of the parent project. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies project_id as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Refs

Developer identifier: runs.refsRefs records comma-separated list of reference IDs or requirements linked to this run. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by refs from the test record to their external records.
Interpretation: The provider supplies refs as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Retest Count

Developer identifier: runs.retest_countRetest Count reports the number of tests marked for retest in the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported retest count for each test rail run record.
Interpretation: The provider supplies retest_count at test rail run granularity as a count at one value per record; zero and missing are not interchangeable.

Suite ID

Developer identifier: runs.suite_idSuite ID is the ID of the suite this run is based on. It is needed to resolve references that repeat the same provider identifier.

Enables: match run records to provider records that carry the same suite ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies suite_id as a record-level identifier on TestRailRun. It is not a uniqueness guarantee unless a connector directive says so.

Untested Count

Developer identifier: runs.untested_countUntested Count reports the number of untested tests in the run. It preserves the stated measure at this record’s granularity.

Enables: measure the provider-reported untested count for each test rail run record.
Interpretation: The provider supplies untested_count at test rail run granularity as a count at one value per record; zero and missing are not interchangeable.

Updated On

Developer identifier: runs.updated_onUpdated On records unix timestamp when the run was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place run records on a timeline by updated on and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_on per test rail run record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

URL

Developer identifier: runs.urlURL records full URL to the run in the TestRail web UI. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by URL on a test rail run record.
Interpretation: The provider supplies url as a URL or resource locator on each test rail run record. Availability still follows the provider’s permissions and retention.

Suites

Developer identifier: suitesSuites contain test suites for a project. Returns a bare array for single-suite projects and a paginated dict for multi-suite projects.

Enables: organize test cases by their parent project and suite mode.
Scope: Reads the declared collection through GET /index.php?/api/v2/get_suites/{id} as a full snapshot. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Completed On

Developer identifier: suites.completed_onCompleted On states UNIX timestamp indicating when the suite was marked as completed, if applicable. It preserves the provider’s current classification of this record.

Enables: separate suite records by the exact provider-reported completed on value when describing their recorded state.
Interpretation: The provider supplies completed_on per test rail suite record using its own state vocabulary; unknown and missing values must remain distinct.

Created By

Developer identifier: suites.created_byCreated By identifies the TestRail user who created the suite. It preserves the user relationship behind suite authorship.

Enables: join suites to their creating users for ownership and audit analysis.
Interpretation: The provider supplies created_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Created On

Developer identifier: suites.created_onCreated On records UNIX timestamp indicating when the suite was created. It anchors the named event or boundary on the record’s timeline.

Enables: place suite records on a timeline by created on and select the records within an explicit reporting window.
Interpretation: The provider supplies created_on per test rail suite record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Description

Developer identifier: suites.descriptionDescription records description of the test suite, providing context about its purpose and scope. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description value attached to each test rail suite record.
Interpretation: The provider supplies description at test rail suite granularity in the format stated by its description; omitted or redacted content remains unknown.

Developer identifier: suites.idID is the unique identifier for the test suite. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail suite source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail suite record, and x-transformDedupKey explicitly marks it as the record key.

Is Baseline

Developer identifier: suites.is_baselineIs Baseline indicates whether this suite is a baseline suite. Baseline suites represent a frozen snapshot of test cases. It preserves the provider-reported yes-or-no condition for this record.

Enables: select suite records for which the provider reports is baseline as true or false.
Interpretation: The provider supplies is_baseline as a boolean per test rail suite record; false and missing are distinct when the field is optional.

Is Completed

Developer identifier: suites.is_completedIs Completed indicates whether this suite is marked completed. It preserves the provider-reported yes-or-no condition for this record.

Enables: select suite records for which the provider reports is completed as true or false.
Interpretation: The provider supplies is_completed as a boolean per test rail suite record; false and missing are distinct when the field is optional.

Is Copy

Developer identifier: suites.is_copyIs Copy indicates whether this suite is a copy of another suite. It preserves the provider-reported yes-or-no condition for this record.

Enables: select suite records for which the provider reports is copy as true or false.
Interpretation: The provider supplies is_copy as a boolean per test rail suite record; false and missing are distinct when the field is optional.

Is Master

Developer identifier: suites.is_masterIs Master indicates whether this is the master suite. In single-suite mode projects, the master suite is the primary and only suite. It preserves the provider-reported yes-or-no condition for this record.

Enables: select suite records for which the provider reports is master as true or false.
Interpretation: The provider supplies is_master as a boolean per test rail suite record; false and missing are distinct when the field is optional.

Name

Developer identifier: suites.nameName records name of the test suite. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name value attached to each test rail suite record.
Interpretation: The provider supplies name at test rail suite granularity in the format stated by its description; omitted or redacted content remains unknown.

Project ID

Developer identifier: suites.project_idProject ID is the ID of the parent project this suite belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match suite records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies project_id as a record-level identifier on TestRailSuite. It is not a uniqueness guarantee unless a connector directive says so.

Updated By

Developer identifier: suites.updated_byUpdated By identifies the TestRail user who last updated the suite. It preserves the user relationship behind the latest recorded change.

Enables: join suites to their last-updating users for change and audit analysis.
Interpretation: The provider supplies updated_by as a numeric user identifier, not a count or measure; resolve it against the matching TestRail user ID.

Updated On

Developer identifier: suites.updated_onUpdated On records UNIX timestamp indicating when the suite was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place suite records on a timeline by updated on and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_on per test rail suite record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

URL

Developer identifier: suites.urlURL records direct URL to the suite in the TestRail web interface. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by URL on a test rail suite record.
Interpretation: The provider supplies url as a URL or resource locator on each test rail suite record. Availability still follows the provider’s permissions and retention.

Tests

Developer identifier: testsTests contain tests within a run.

Enables: inspect the test instances included in each run.
Scope: Reads the declared collection through GET /index.php?/api/v2/get_tests/{id} as a full snapshot. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Provider-defined fields may also be returned for this data stream.

Assignedto ID

Developer identifier: tests.assignedto_idAssignedto ID identifies user ID assigned to the test. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same assignedto ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies assignedto_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Case ID

Developer identifier: tests.case_idCase ID is the ID of the related test case. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same case ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies case_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Custom Automation Type

Developer identifier: tests.custom_automation_typeCustom Automation Type records custom field: automation type identifier (common custom field). It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom automation type according to the provider and Workspace configuration that produced each test record.
Interpretation: Keys and value shapes within custom_automation_type can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Expected

Developer identifier: tests.custom_expectedCustom Expected records custom field: expected results in text format. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom expected according to the provider and Workspace configuration that produced each test record.
Interpretation: Keys and value shapes within custom_expected can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Goals

Developer identifier: tests.custom_goalsCustom Goals records custom field: goals for exploratory testing. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom goals according to the provider and Workspace configuration that produced each test record.
Interpretation: Keys and value shapes within custom_goals can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Mission

Developer identifier: tests.custom_missionCustom Mission records custom field: mission/charter for exploratory testing. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom mission according to the provider and Workspace configuration that produced each test record.
Interpretation: Keys and value shapes within custom_mission can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Preconds

Developer identifier: tests.custom_precondsCustom Preconds records custom field: preconditions for the test. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom preconds according to the provider and Workspace configuration that produced each test record.
Interpretation: Keys and value shapes within custom_preconds can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Steps

Developer identifier: tests.custom_stepsCustom Steps records custom field: test steps in text format. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom steps according to the provider and Workspace configuration that produced each test record.
Interpretation: Keys and value shapes within custom_steps can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Custom Steps Separated

Developer identifier: tests.custom_steps_separatedCustom Steps Separated records custom field: test steps as structured separated steps. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret custom steps separated according to the provider and Workspace configuration that produced each test record.
Interpretation: Keys and value shapes within custom_steps_separated can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Additional Info

Developer identifier: tests.custom_steps_separated.additional_infoAdditional Info records additional information or notes for the step. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact additional info value attached to each test rail custom step record.
Interpretation: The provider supplies additional_info at test rail custom step granularity in the format stated by its description; omitted or redacted content remains unknown.

Content

Developer identifier: tests.custom_steps_separated.contentContent captures the step description or action to perform. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact content value attached to each test rail custom step record.
Interpretation: The provider supplies content at test rail custom step granularity in the format stated by its description; omitted or redacted content remains unknown.

Expected

Developer identifier: tests.custom_steps_separated.expectedExpected captures the expected result of the step. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact expected value attached to each test rail custom step record.
Interpretation: The provider supplies expected at test rail custom step granularity in the format stated by its description; omitted or redacted content remains unknown.

Refs

Developer identifier: tests.custom_steps_separated.refsRefs records reference IDs associated with this step. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by refs from the test record to their external records.
Interpretation: The provider supplies refs as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Shared Step ID

Developer identifier: tests.custom_steps_separated.shared_step_idShared Step ID is the ID of a shared step if this step references one. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same shared step ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies shared_step_id as a record-level identifier on TestRailCustomStep. It is not a uniqueness guarantee unless a connector directive says so.

Estimate

Developer identifier: tests.estimateEstimate records the planned execution duration for the test. It preserves TestRail’s human-readable duration text.

Enables: compare planned effort across tests and schedule execution using the recorded estimate.
Interpretation: The provider supplies estimate as duration text such as 30s or 1m 45s; parse TestRail’s units rather than treating the string as an ordinal.

Estimate Forecast

Developer identifier: tests.estimate_forecastEstimate Forecast records the execution duration forecast from historical test results. It preserves TestRail’s predicted duration text for the test.

Enables: compare forecasted execution effort with the authored estimate and plan test capacity.
Interpretation: The provider supplies estimate_forecast as provider-formatted duration text such as 30s or 1m 45s, not an ordinal or sequence.

Developer identifier: tests.idID is the unique test identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail test source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail test record, and x-transformDedupKey explicitly marks it as the record key.

Labels

Developer identifier: tests.labelsLabels records labels associated with the test. TestRail returns objects with id and title. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact labels value attached to each test rail test record.
Interpretation: The provider supplies labels at test rail test granularity in the format stated by its description; omitted or redacted content remains unknown.

Developer identifier: tests.labels.idID is the unique label identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail label source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail label record, and x-transformDedupKey explicitly marks it as the record key.

Title

Developer identifier: tests.labels.titleTitle records display name of the label. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact title value attached to each test rail label record.
Interpretation: The provider supplies title at test rail label granularity in the format stated by its description; omitted or redacted content remains unknown.

Milestone ID

Developer identifier: tests.milestone_idMilestone ID is the ID of the associated milestone. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same milestone ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies milestone_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Priority ID

Developer identifier: tests.priority_idPriority ID is the ID of the test priority level. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same priority ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies priority_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Refs

Developer identifier: tests.refsRefs records comma-separated reference IDs linking to external systems such as issue trackers. It preserves the external requirement or defect references attached to the test record.

Enables: trace the requirements or defects named by refs from the test record to their external records.
Interpretation: The provider supplies refs as a delimited set of external references per test record; the connector does not verify that each referenced record exists.

Run ID

Developer identifier: tests.run_idRun ID is the ID of the parent test run. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same run ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies run_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Section ID

Developer identifier: tests.section_idSection ID is the ID of the section the test case belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same section ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies section_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Status ID

Developer identifier: tests.status_idStatus ID identifies current status of the test (e.g., 1=Passed, 2=Blocked, 3=Untested, 4=Retest, 5=Failed). It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same status ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies status_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Template ID

Developer identifier: tests.template_idTemplate ID is the ID of the template used by the test case. It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same template ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies template_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Title

Developer identifier: tests.titleTitle records title of the test, typically inherited from the test case. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact title value attached to each test rail test record.
Interpretation: The provider supplies title at test rail test granularity in the format stated by its description; omitted or redacted content remains unknown.

Type ID

Developer identifier: tests.type_idType ID is the ID of the test type (e.g., Automated, Functionality, Performance). It is needed to resolve references that repeat the same provider identifier.

Enables: match test records to provider records that carry the same type ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies type_id as a record-level identifier on TestRailTest. It is not a uniqueness guarantee unless a connector directive says so.

Users

Developer identifier: usersUsers contain all TestRail users.

Enables: resolve TestRail identities referenced by test-management records.
Scope: Reads the declared collection through GET /index.php?/api/v2/get_users as a full snapshot. Results contain only TestRail records visible to the configured account and each required parent project, suite, or run.

Assigned Projects

Developer identifier: users.assigned_projectsAssigned Projects records IDs of projects assigned to the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the test rail user record to the provider-reported person or account represented by assigned projects.
Interpretation: The provider supplies assigned_projects as identity or attribution context on each test rail user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: users.emailEmail records email address of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the test rail user record to the provider-reported person or account represented by email.
Interpretation: The provider supplies email as identity or attribution context on each test rail user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Email Notifications

Developer identifier: users.email_notificationsEmail Notifications indicates whether the user receives email notifications. It preserves the provider-reported yes-or-no condition for this record.

Enables: select user records for which the provider reports email notifications as true or false.
Interpretation: The provider supplies email_notifications as a boolean per test rail user record; false and missing are distinct when the field is optional.

Group IDs

Developer identifier: users.group_idsGroup IDs identifies IDs of groups the user belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match user records to provider records that carry the same group ids, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies group_ids as a record-level identifier on TestRailUser. It is not a uniqueness guarantee unless a connector directive says so.

Developer identifier: users.idID is the unique identifier for the user. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same test rail user source row before constructing its represented state.
Interpretation: The provider supplies id at one value per test rail user record, and x-transformDedupKey explicitly marks it as the record key.

Is Active

Developer identifier: users.is_activeIs Active indicates whether the user account is currently active. It preserves the provider-reported yes-or-no condition for this record.

Enables: select user records for which the provider reports is active as true or false.
Interpretation: The provider supplies is_active as a boolean per test rail user record; false and missing are distinct when the field is optional.

Is Admin

Developer identifier: users.is_adminIs Admin indicates whether the user has administrator privileges. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported is admin attached to each test rail user record.
Interpretation: The provider supplies is_admin at test rail user granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

MFA Required

Developer identifier: users.mfa_requiredMFA Required indicates whether multi-factor authentication is required for the user. It preserves the provider-reported yes-or-no condition for this record.

Enables: select user records for which the provider reports MFA required as true or false.
Interpretation: The provider supplies mfa_required as a boolean per test rail user record; false and missing are distinct when the field is optional.

Name

Developer identifier: users.nameName records display name of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the test rail user record to the provider-reported person or account represented by name.
Interpretation: The provider supplies name as identity or attribution context on each test rail user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Role

Developer identifier: users.roleRole states name of the user’s assigned role. It documents the access-related value reported for this object or membership.

Enables: describe the provider-reported role attached to each test rail user record.
Interpretation: The provider supplies role at test rail user granularity. It describes provider-reported context and does not prove effective access beyond the returned record.

Role ID

Developer identifier: users.role_idRole ID is the ID of the role assigned to the user. It is needed to resolve references that repeat the same provider identifier.

Enables: match user records to provider records that carry the same role ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies role_id as a record-level identifier on TestRailUser. It is not a uniqueness guarantee unless a connector directive says so.

SSO Enabled

Developer identifier: users.sso_enabledSSO Enabled indicates whether single sign-on is enabled for the user. It preserves the provider-reported yes-or-no condition for this record.

Enables: select user records for which the provider reports SSO enabled as true or false.
Interpretation: The provider supplies sso_enabled as a boolean per test rail user record; false and missing are distinct when the field is optional.

Error	Meaning	Solution
`401 Unauthorized`	Invalid credentials	Verify email and API key
`403 Forbidden`	API not enabled	Enable API in user settings
`404 Not Found`	Wrong endpoint	Check URL and API version

TestRail API — Official API documentation

​Test Cases

​Results

​Data streams

​TestRail

​What You’ll Need

​Step 1: Access User Settings

​Step 2: Enable API Key

​Step 3: Note Instance URL

​Step 4: Enter values in the form

Test Cases

Results

Data streams

TestRail

What You’ll Need

Step 1: Access User Settings

Step 2: Enable API Key

Step 3: Note Instance URL

Step 4: Enter values in the form