...
These are the expected status codes returned by the service - in . 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).
...
An example of starting the re-indexing reindexing of a individual project by passing in the project's unique GUID identifier as a parameter to the 'Reindex' background task type.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Type": "Reindex", "Parameters": { "Optimize": true, "ProjectId": "c651ed19-5375-475a-a539-9f6401467130" } } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Complete": false, "TotalElements": 10, "ProcessedElements": 1, "StartedAt": "2011-12-31T21:50:00Z", "ProgressInPercent": 0.1, "Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b", "Message": "Queuing index events", "Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b" } |
Status Code
202 - Accepted
An Example example of starting the re-indexing of all projects in Enterprise Tester without optimization, and skipping relationship re-indexing.reindexing of a individual project by passing in the project's unique GUID identifier as a parameter to the 'Reindex' background task type. This also makes use of the 'StreamProgress' option which will stream progress updates back as a JSON array until the background task is complete.
Request HeadersRequest Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Type": "Reindex", "Parameters": { "Optimize": true, "ProjectId": "c651ed19-5375-475a-a539-9f6401467130" }, "StreamProgress": true } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
[
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 1,
"StartedAt": "2013-12-31T21:50:00Z",
"ProgressInPercent": 0.1,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Queuing index events"
},
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 5,
"StartedAt": "2013-12-31T21:50:01Z",
"ProgressInPercent": 0.5,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Process queued events"
},
{
"Complete": true,
"TotalElements": 10,
"ProcessedElements": 10,
"StartedAt": "2013-12-31T21:50:00Z",
"FinishedAt": "2013-12-31T21:50:02Z",
"ProgressInPercent": 1.0,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": null
}
]
|
Status Code
202 - Accepted
An example of starting the reindexing background task but disabling the clear second-level cache behavior. This can decrease time to reindex if no changes have been made to ET data except via the API/UI (e.g. you have not restored a database backup or run any queries to directly change the ET database).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{
"Type": "Reindex",
"Parameters": {
"Optimize": true,
"ClearCache": false,
"ProjectId": "c651ed19-5375-475a-a539-9f6401467130"
}
}
|
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 1,
"StartedAt": "2011-12-31T21:50:00Z",
"ProgressInPercent": 0.1,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Queuing index events",
"Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b"
}
|
Status Code
202 - Accepted
An example of starting the reindexing for incidents only of a single project.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{
"Type": "Reindex",
"Parameters": {
"Optimize": true,
"IncidentsOnly": true,
"ProjectId": "c651ed19-5375-475a-a539-9f6401467130"
}
}
|
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 1,
"StartedAt": "2011-12-31T21:50:00Z",
"ProgressInPercent": 0.1,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Queuing index events",
"Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b"
}
|
Status Code
202 - Accepted
An example of starting the reindexing of an individual execution package and all its children by passing in the package's unique GUID identifier as a parameter to the 'Reindex' background task type. Package reindexing does not clear the index, so this can be run without any loss of functionality to users to ET, unlike a project/ allprojects reindex.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{
"Type": "Reindex",
"Parameters": {
"ExecutionPackageId": "c651ed19-5375-475a-a539-9f6401467130"
}
}
|
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 1,
"StartedAt": "2011-12-31T21:50:00Z",
"ProgressInPercent": 0.1,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Queuing index events",
"Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b"
}
|
Status Code
202 - Accepted
An example of starting the reindexing of a individual script package and all its children by passing in the package's unique GUID identifier as a parameter to the 'Reindex' background task type. Package reindexing does not clear the index, so this can be run without any loss of functionality to users to ET, unlike a project/all projects reindex.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{
"Type": "Reindex",
"Parameters": {
"ScriptPackageId": "c651ed19-5375-475a-a539-9f6401467130"
}
}
|
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 1,
"StartedAt": "2011-12-31T21:50:00Z",
"ProgressInPercent": 0.1,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Queuing index events",
"Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b"
}
|
Status Code
202 - Accepted
An example of starting the reindexing of a individual requirement package and all its children by passing in the package's unique GUID identifier as a parameter to the 'Reindex' background task type. Package reindexing does not clear the index, so this can be run without any loss of functionality to users to ET, unlikely a project/all projects reindex.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{
"Type": "Reindex",
"Parameters": {
"RequirementPackageId": "c651ed19-5375-475a-a539-9f6401467130"
}
}
|
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 1,
"StartedAt": "2011-12-31T21:50:00Z",
"ProgressInPercent": 0.1,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Queuing index events",
"Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b"
}
|
Status Code
202 - Accepted
An example of starting the reindexing of all projects in Enterprise Tester without optimization, and skipping relationship reindexing.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{
"Type": "Reindex",
"Parameters": {
"Optimize": false,
"SkipRelationships": true
}
}
|
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{
"Complete": false,
"TotalElements": 10,
"ProcessedElements": 1,
"StartedAt": "2011-12-31T21:50:00Z",
"ProgressInPercent": 0.1,
"Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b",
"Message": "Queuing index events",
"Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b"
}
|
Status Code
202 - Accepted
An example of starting the reindexing of specific entities only. Unlike other reindexing tasks this one won't wait for the reindexing to complete, and is intended as a 'fire-and-forget' task you can quickly invoke to re-sync the index after making changes to entities directly in the database.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Type": "Reindex", "Parameters": { "Optimize": false, "Entities": [ { "Id": "f2a5fcee-3811-4672-abe1-2e26b7ebf8f9", "Type": "Requirement" }, { "Id": "59780535-3cc6-431f-b8f6-5d4dc378bf5b", "Type": "TestScript" }, { "Id": "f6b4fb38-b211-46f7-9a64-2fe3c10c3d59", "Type": "TestScriptAssignment" }, { "Id": "c52aff95-42dc-4de9-8419-591ed959fd08", "Type": "ReindexIncident", "Parameters": { } "Optimize": false], "SkipRelationships": true } } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Complete": false, "TotalElements": 104, "ProcessedElements": 1, "StartedAt": "2011-12-31T21:50:00Z", "ProgressInPercent": 0.1, "Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b", "Message": "Queuing index events"null, "Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b409-a2939851241b" } |
Status Code
202 - Accepted
Links This example shows how to link a ticket to a Script Assignment's Step Result, . Tickets is the term used for external incidents stored in defect trackers.
This background task allows you to link to a ticket via it's using its unique key, as . As part of this the linking process an associated Incident incident synchronized with the Ticket ticket will be created in Enterprise Tester, if an Incident incident does not already exist. An error (500) will be returned by this background task if the Ticket ticket can not be found, or is already linked to the Step Result.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Type": "LinkTicketToStepResult", "Parameters": { "StepResultId": "ad3c8f9a-6959-4226-9b47-a0a601595de4", "Key": "TST-123" } } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/linktickettostepresult_d58d140f-fdd5-4d3e-b08b-4629b0b02da5 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Complete": false, "TotalElements": 3, "ProcessedElements": 2, "StartedAt": "2011-12-31T21:50:00Z", "ProgressInPercent": 0.67, "Id": "linktickettostepresult_d58d140f-fdd5-4d3e-b08b-4629b0b02da5", "Message": "Creating link", "Self": "http://localhost/api/backgroundtask/linktickettostepresult_d58d140f-fdd5-4d3e-b08b-4629b0b02da5" } |
Status Code
202 - Accepted
This example demonstrates passing an additional parameter to disambiguate the Key key for the ticket (ExternalSystemLinkId) - this . This is necessary if the project has 1 or more associated Defect Tracker external systems, and the ticket Key's keys are duplicated in both systems. Note: This additional parameter is also supported by the 'LinkTicketToAgileRunStep' and 'LinkTicketToAutomatedTestRunResultNode' task types.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Type": "LinkTicketToStepResult", "Parameters": { "StepResultId": "ad3c8f9a-6959-4226-9b47-a0a601595de4", "ExternalSystemLinkId": "d8e4c6a3-5287-4b38-82f8-7791adcb6dc9", "Key": "TST-123" } } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/linktickettostepresult_d58d140f-fdd5-4d3e-b08b-4629b0b02da5 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Complete": false, "TotalElements": 3, "ProcessedElements": 2, "StartedAt": "2011-12-31T21:50:00Z", "ProgressInPercent": 0.67, "Id": "linktickettostepresult_d58d140f-fdd5-4d3e-b08b-4629b0b02da5", "Message": "Creating link", "Self": "http://localhost/api/backgroundtask/linktickettostepresult_d58d140f-fdd5-4d3e-b08b-4629b0b02da5" } |
Status Code
202 - Accepted
Links This examples shows how to link a ticket to a Agile Run's Step, . Tickets is the term used for external incidents stored in defect trackers.
This background task allows you to link to a ticket via it's using its unique key, as part of this linking process an associated Incident incident synchronized with the Ticket ticket will be created in Enterprise Tester, if an Incident incident does not already exist. An error (500) will be returned by this background task if the Ticket ticket can not be found, or is already linked to the Agile Run's Step.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Type": "LinkTicketToAgileRunStep", "Parameters": { "AgileRunId": "161e7eed-2cd7-45cc-97d9-a00f010e3aa4", "StepId": "79853241-febd-4f5d-93bf-4d380d024206", "Key": "TST-123" } } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/linktickettoagilerunstep_d58d140f-fdd5-4d3e-b08b-4629b0b02da5 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Complete": false, "TotalElements": 3, "ProcessedElements": 2, "StartedAt": "2011-12-31T21:50:00Z", "ProgressInPercent": 0.67, "Id": "linktickettoagilerunstep_d58d140f-fdd5-4d3e-b08b-4629b0b02da5", "Message": "Creating link", "Self": "http://localhost/api/backgroundtask/linktickettoagilerunstep_d58d140f-fdd5-4d3e-b08b-4629b0b02da5" } |
Status Code
202 - Accepted
Links This example shows how to link a ticket to a Result Node result node in Automated Test Run, . Tickets is the term used for external incidents stored in defect trackers.
This background task allows you to link to a ticket via it's using its unique key, as . As part of this linking process an associated Incident incident synchronized with the Ticket ticket will be created in Enterprise Tester, if an Incident incident does not already exist. An error (500) will be returned by this background task if the Ticket ticket can not be found, or is already linked to the Automated Test's Result Node.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json | |
Content-type | application/json |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Type": "LinkTicketToAutomatedTestRunResultNode", "Parameters": { "AutomatedTestRunId": "ad3c8f9a-6959-4226-9b47-a0a601595de4", "ResultNodeId": "3aaf3505-85ca-43c4-a822-fe468118aab7", "Key": "TST-123" } } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 | |
Location | http://localhost/api/linktickettoautomatedtestrunresultnode_d58d140f-fdd5-4d3e-b08b-4629b0b02da5 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Complete": false, "TotalElements": 3, "ProcessedElements": 2, "StartedAt": "2011-12-31T21:50:00Z", "ProgressInPercent": 0.67, "Id": "linktickettoautomatedtestrunresultnode_d58d140f-fdd5-4d3e-b08b-4629b0b02da5", "Message": "Creating link", "Self": "http://localhost/api/backgroundtask/linktickettoautomatedtestrunresultnode_d58d140f-fdd5-4d3e-b08b-4629b0b02da5" } |
Status Code
202 - Accepted
...