Help Contents
-
System Administration
-
User Guide & Application Administration Guide
-
Using Enterprise Tester
-
Application Administration
-
Searching & TQL
-
API
-
API / Permissions
-
Features
-
Resources
-
Agile Run
-
Agile Run All Relationships
-
Agile Run Relationships
-
Agile Runs
-
Agile Run Step Attachments
-
Agile Run Step Incident
-
Agile Run Step Incidents
-
Agile Run Step Result Attachment
-
API / Resources / Resources / Search #1
-
API / Resources / Resources / Search #2
-
Assigned To Search
-
Attachment Contents
-
Automated Test
-
Automated Test All Relationships
-
Automated Test Assignment
-
Automated Test Assignment All Relationships
-
Automated Test Assignment Relationships
-
Automated Test Assignment Runs
-
Automated Test Assignments
-
Automated Test Relationships
-
Automated Test Run
-
Automated Test Run Attachment
-
Automated Test Run Attachments
-
Automated Test Run Data
-
Automated Test Run Incident
-
Automated Test Run Incidents
-
Automated Test Run Node Attachment
-
Automated Test Run Node Attachments
-
Automated Test Run Result Children
-
Automated Test Run Result Node
-
Automated Test Run Result Root Nodes
-
Automated Test Runs
-
Automated Tests
-
Automated Test Schedule
-
Automated Test Schedule Import Configuration
-
Automated Test Schedule Import Configurations
-
Automated Test Schedules
-
Automated Test Schedule Schedule Configuration
-
Automated Test Schedule Schedule Configuration Run
-
Automated Test Schedule Schedule Configurations
-
Automated Test Type
-
Automated Test Types
-
Background Task
-
Background Tasks
-
Custom Field
-
Custom Fields (Resources)
-
Custom Field Type
-
Custom Field Types
-
Event Types Search
-
Execution Package
-
Execution Package Children
-
Execution Packages
-
Export File
-
External Source Metadata
-
External Sources Metadata
-
External System
-
External System's Links
-
External System Link
-
External System Link Copy
-
External System Link Field Values
-
External System Links
-
External System Links Search
-
External System Link Ticket
-
External System Link Ticket Link
-
External Systems
-
External System Type
-
External System Types
-
Grid Widget Data
-
Grid Widget State
-
Grid Widget States
-
Group
-
Group Permission Projects
-
Group Permissions
-
Groups
-
Groups Search
-
Group Users
-
Incident
-
Incident All Relationships
-
Incident Attachment
-
Incident Attachments
-
Incident Comments
-
Incident Relationships
-
Incident Relationships All Relationships
-
Incidents
-
Latest Performance Measurement
-
Mail Queue Messages
-
Mail Sender Settings
-
Notification
-
Notification Entity Type Search
-
Notifications (Resources)
-
Organisation (Resources)
-
Organisation Picklist
-
Organisation Picklist Search
-
Organisation Relationship Types
-
Organisations
-
Permission
-
Permissions (Resources)
-
Project (Resources)
-
Project Assignees
-
Project Categories
-
Project Category
-
Project Category Children
-
Project Group Permissions
-
Project Picklist
-
Project Picklist Search
-
Projects
-
Projects Search
-
Project Templates
-
Project Tickets
-
Project User Permissions
-
Relationship (Resources)
-
Relationships (Resources)
-
Relationship Type (Resources)
-
Relationship Types
-
Requirement
-
Requirement All Relationships
-
Requirement Attachment
-
Requirement Attachments
-
Requirement Children
-
Requirement Comments
-
Requirement Package
-
Requirement Package Children
-
Requirement Packages
-
Requirement Relationships
-
Requirements (Resources)
-
Resources / Custom Fields
-
Resources / Notifications
-
Resources / Organisation
-
Resources / Permissions
-
Resources / Project
-
Resources / Relationship
-
Resources / Relationships
-
Resources / Relationship Type
-
Resources / Requirements
-
Resources / Script
-
Resources / Search
-
Resources / Widgets
-
Root
-
Rover Execution Tree
-
Rover Licensing Info
-
Script's Assignments
-
Script (Resources)
-
Script All Relationships
-
Script Assignment
-
Script Assignment All Relationships
-
Script Assignment Relationships
-
Script Assignment Runs
-
Script Assignments
-
Script Attachment
-
Script Attachments
-
Script Package
-
Script Package Children
-
Script Packages
-
Script Relationships
-
Script Run
-
Script Runs
-
Scripts
-
Search (Resources)
-
Search Index
-
Search Indexes
-
Step Result
-
Step Result Attachment
-
Step Result Attachments
-
Step Result Incident
-
Step Result Incidents
-
Swagger API
-
Swagger API List
-
Synchronizer Schedule
-
Synchronizer Schedule Run
-
Synchronizer Schedules
-
System Event
-
System Events
-
System Info
-
Temporary Attachment Set
-
Temporary Attachment Set Attachment
-
Temporary Attachments Set
-
Test Automated Test Assignments
-
Time Zone
-
User
-
User Groups
-
User Mail
-
User Password
-
User Permission Projects
-
User Permissions
-
Users
-
Users and Group Search
-
Users Search
-
Agile Run
-
Swagger
-
API / Permissions
-
Using Enterprise Tester
-
Platform Plugins
-
Troubleshooting
-
Earlier Versions of this Documentation
-
Support & Bug Fixes
Resource: Search ( /api/search )
Search resource, used for retrieving the results of a TQL query.
Root Relation: Search
This resource supports the following methods: GET, POST
Methods
GET
Retrieves all (or a subset) of entities that are visible to the user. The search resource supports both standard and aggregate TQL query expressions. For long queries you can use the POST method instead.
This method supports the TQL query parameters tql, $top, $take and $inlinecount. See TQL Topic for more details.
Required Permissions
- TestManagement/View
Status Codes
These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successfully. |
Searching for entities by TQL query.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Name ~ 'test' | Search for all entities containing the word 'test'. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 0, "Top": 1, "Total": 1, "Items": [ { "Id": "48adfe56-69a6-4832-b826-a004016a11e2", "Type": "Unit", "Name": "JUnit Test Results", "CreatedAt": "2012-02-27T08:58:15Z", "LastUpdatedAt": "2012-02-27T10:08:20Z", "CreatedById": "5b2b0ad0-5371-4abf-a661-9f410088925f", "CreatedBy": "Administrator", "LastUpdatedById": "5b2b0ad0-5371-4abf-a661-9f410088925f", "LastUpdatedBy": "Administrator", "PackageId": "d69ff488-5a76-4b8c-b604-9fde010719e1", "ProjectId": "2aa8fba4-8f0b-4c4b-a7ef-9fde010719de", "ProjectName": "Project X", "PackageName": "Script Library", "OrderNumber": 2, "Expands": [ "Assignments", "Configuration" ], "EntityType": "AutomatedTest", "Self": "http://localhost/EnterpriseTester/api/automatedtest/48adfe56-69a6-4832-b826-a004016a11e2" } }
Status Code
200 - OK
Searching for entities by TQL query that includes dates, and pass in timezone for the query.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | CreatedAt >= 2012-02-1 | Search for all entities created on February 2012 and later. |
timeZone | America/New_York | Time zone used for date calculations. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 0, "Top": 1, "Total": 1, "Items": [ { "Id": "48adfe56-69a6-4832-b826-a004016a11e2", "Type": "Unit", "Name": "JUnit Test Results", "CreatedAt": "2012-02-27T08:58:15Z", "LastUpdatedAt": "2012-02-27T10:08:20Z", "CreatedById": "5b2b0ad0-5371-4abf-a661-9f410088925f", "CreatedBy": "Administrator", "LastUpdatedById": "5b2b0ad0-5371-4abf-a661-9f410088925f", "LastUpdatedBy": "Administrator", "PackageId": "d69ff488-5a76-4b8c-b604-9fde010719e1", "ProjectId": "2aa8fba4-8f0b-4c4b-a7ef-9fde010719de", "ProjectName": "Project X", "PackageName": "Script Library", "OrderNumber": 2, "Expands": [ "Assignments", "Configuration" ], "EntityType": "AutomatedTest", "Self": "http://localhost/EnterpriseTester/api/automatedtest/48adfe56-69a6-4832-b826-a004016a11e2" } }
Status Code
200 - OK
Searching for entities by TQL query (using different index) - Note: within the response the 'IndexName' is also included as a top-level property.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Name ~ 'smoke' | Search for all entities containing the word 'smoke'. |
indexName | Run | Search using the Run index. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 0, "Top": 1, "Total": 1, "Items": [ { "Id": "a2e642a5-bd5d-48e6-b67d-a153017a5272", "AssignedToId": null, "AssignedTo": null, "Description": null, "Name": "Smoke test integration with SAP", "Notes": null, "Number": 5, "Objective": null, "PostCondition": null, "PreCondition": null, "PriorityId": "8f8dc3ff-f98b-411c-9bd3-a14300fbebc0", "StatusId": "a15eb86a-ce86-42c7-9881-a14300fbebc4", "TypeId": "fa450444-cf62-4b1f-b9c4-a14300fbebc6", "SourceId": null, "SourceContainerId": null, "PackageId": "e4658145-e54d-4a11-8550-a14300fbebca", "OrderNumber": 0, "ProjectId": "8dfa0afa-25ee-4ce1-bc92-a14300fbebb2", "ProjectName": "Test", "PackageName": "Execution Sets", "EstimatedDuration": "", "ActualDuration": "", "ExecutionStatus": "Not Run", "AgileRunNumberReadOnly": true, "Expands": [ "FieldControls", "FieldValues", "Steps" ], "EntityType": "AgileRun", "Self": "http://localhost/EnterpriseTester/api/agilerun/a2e642a5-bd5d-48e6-b67d-a153017a5272", "Links": [ { "Href": "http://localhost/EnterpriseTester/api/agilerun/a2e642a5-bd5d-48e6-b67d-a153017a5272/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/EnterpriseTester/api/agilerun/a2e642a5-bd5d-48e6-b67d-a153017a5272/allrelationships", "Rel": "AllRelationships" } ] }], "IndexName": "Run", "Self": "http://localhost:8092/EnterpriseTester/api/search?indexName=Run", "Links": [ { "Href": "http://localhost:8092/EnterpriseTester/api/search?indexName=Run&$skip=25&$top=25", "Rel": "next" }, { "Href": "http://localhost:8092/EnterpriseTester/api/search?indexName=Run&$skip=95&$top=25", "Rel": "last" } ] } }
Status Code
200 - OK
Searching for entities by TQL query (format results flattened for grid).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Name ~ 'test' | Search for all entities containing the word 'test'. |
format | grid | Format the results for rendering in a grid. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 0, "Top": 1, "Total": 1, "Items": [ { "AssociatedRequirements": "", "Type": "Unit", "Name": "JUnit Test Results", "OrderNumber": 2, "Id": "48adfe56-69a6-4832-b826-a004016a11e2", "EntityType": "AutomatedTest", "Package": "Project X/Script Library", "CreatedAt": "2012-02-27T08:58:15Z", "LastUpdatedAt": "2012-02-27T10:08:20Z", "LastUpdatedBy": "Joe Bloggs (Administrator)", "CreatedBy": "Joe Bloggs (Administrator)", "EditLink": "#/automatedtest/edit/48adfe56-69a6-4832-b826-a004016a11e2", "PackageId": "d69ff488-5a76-4b8c-b604-9fde010719e1", "Project": "Project X", "ProjectId": "2aa8fba4-8f0b-4c4b-a7ef-9fde010719de" } },
Status Code
200 - OK
Searching for entities by TQL query (format results flattened for grid, with column metadata included in the results).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Name ~ 'test' | Search for all entities containing the word 'test'. |
format | grid | Format the results for rendering in a grid. |
$expand | Columns | Returns the grid results with column metadata. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 0, "Top": 1, "Total": 1, "Items": [ { "Columns": [ { "Sortable": true, "DefaultToHidden": false, "Header": "Entity Type", "Name": "EntityType", "Type": "string", "DefaultWidth": 100, "PreEncoded": false }, { "Sortable": true, "DefaultToHidden": false, "Header": "Package", "Name": "Package", "Type": "string", "DefaultWidth": 200, "PreEncoded": false }, { "Sortable": true, "DefaultToHidden": false, "Header": "Name", "Name": "Name", "Type": "string", "DefaultWidth": 50, "PreEncoded": false }, .... ], "AssociatedRequirements": "", "Type": "Unit", "Name": "JUnit Test Results", "OrderNumber": 2, "Id": "48adfe56-69a6-4832-b826-a004016a11e2", "EntityType": "AutomatedTest", "Package": "Project X/Script Library", "CreatedAt": "2012-02-27T08:58:15Z", "LastUpdatedAt": "2012-02-27T10:08:20Z", "LastUpdatedBy": "Joe Bloggs (Administrator)", "CreatedBy": "Joe Bloggs (Administrator)", "EditLink": "#/automatedtest/edit/48adfe56-69a6-4832-b826-a004016a11e2", "PackageId": "d69ff488-5a76-4b8c-b604-9fde010719e1", "Project": "Project X", "ProjectId": "2aa8fba4-8f0b-4c4b-a7ef-9fde010719de" } },
Status Code
200 - OK
Searching for entities by TQL query (format results flattened for grid).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Name ~ 'test' | Search for all entities containing the word 'test'. |
format | grid | Format the results for rendering in a grid. |
$expand | Columns | Returns the grid results with column metadata. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Status Code
200 - OK
Return the results of an aggregated expression.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | GROUP BY Status { Count } as "Statuses" WHERE EntityType = Requirement | Return results of an aggregated expression. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Results": { "Statuses": { "Approved": { "Count": 48 }, "Review Pending": { "Count": 4 }, "In Progress": { "Count": 10 }, "N/A": { "Count": 49 }, "No Run": { "Count": 34 }, "Not Covered": { "Count": 3 }, "Passed": { "Count": 15 }, "Requires Rework": { "Count": 1 } } } }
Status Code
200 - OK
Return the results of an aggregated expression returning results formatted for an ExtJS style tree - this will convert entity results into edit links within ET.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | GROUP BY Status { Count } as "Statuses" WHERE EntityType = Requirement | Return results of an aggregated expression. |
fomat | extjstree | Output results suitable for rendering by a Sencha ExtJS tree component. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Results": { "text": "Results", "expanded": true, "iconCls": "summary-results-root", "children": [ { "text": "Statuses", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Approved", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 48", "iconCls": "summary-results-value-number", "leaf": true } ] }, { "text": "Review Pending", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 4", "iconCls": "summary-results-value-number", "leaf": true } ] }, { "text": "In Progress", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 10", "iconCls": "summary-results-value-number", "leaf": true } ] }, { "text": "N/A", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 49", "iconCls": "summary-results-value-number", "leaf": true } ] }, { "text": "No Run", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 34", "iconCls": "summary-results-value-number", "leaf": true } ] }, { "text": "Not Covered", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 3", "iconCls": "summary-results-value-number", "leaf": true } ] }, { "text": "Passed", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 15", "iconCls": "summary-results-value-number", "leaf": true } ] }, { "text": "Requires Rework", "expanded": true, "iconCls": "summary-results-dictionary", "children": [ { "text": "Count: 1", "iconCls": "summary-results-value-number", "leaf": true } ] } ] } ] } }
Status Code
200 - OK
POST
Retrieves all (or a subset) of entities that are visible to the user. The search resource supports both standard and aggregate TQL query expressions. The parameters must be passed in using the x-www-form-urlencoded content type.
This method supports the TQL query parameters tql, $top, $take and $inlinecount. See TQL Topic for more details.
Required Permissions
- TestManagement/View
Status Codes
These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successfully. |