Resource: Background Tasks ( /api/backgroundtasks )

Collection of background tasks

Root Relation: BackgroundTasks

This resource supports the following methods: POST

Methods

POST

Starts a new background task.

Required Permissions

Enforced by task implementation

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
202 - Accepted	Returned if the task was created successfully.
403 - Forbidden	If you do not have permission to execute this job.
500 - InternalServerError	If the job handler for this background task encountered an unrecoverable error creating the job.

Example - Start project reindex

An example of starting the re-indexing 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

language	none

{
  "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

language	none

{
  "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

Example - Start all-projects reindex

An Example of starting the re-indexing of all projects in Enterprise Tester without optimization, and skipping relationship re-indexing.

Request Headers

Key	Value	Description
Accept	application/json
Content-type	application/json

Request Body

Code Block

language	none

{
  "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

language	none

{
  "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

Example - Link a ticket to a Script Assignment's Step Result

Links 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 unique key, as part of this linking process an associated Incident synchronized with the Ticket will be created in Enterprise Tester, if an Incident does not already exist. An error (500) will be returned by this background task if the 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

language	none

{
  "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

language	none

{
  "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

Example - Link a ticket to a Script Assignment's Step Result (with External System Link specified)

This example demonstrates passing an additional parameter to disambiguate the Key for the ticket (ExternalSystemLinkId) - this is necessary if the project has 1 or more associated Defect Tracker external systems, and the ticket Key's 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

language	none

{
  "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

language	none

{
  "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

Example - Link a ticket to a Agile Run's Step

Links 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 unique key, as part of this linking process an associated Incident synchronized with the Ticket will be created in Enterprise Tester, if an Incident does not already exist. An error (500) will be returned by this background task if the 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

language	none

{
  "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

language	none

{
  "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

Example - Link a ticket to a Automated Test Run's Result Node

Links a ticket to a 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 unique key, as part of this linking process an associated Incident synchronized with the Ticket will be created in Enterprise Tester, if an Incident does not already exist. An error (500) will be returned by this background task if the 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

language	none

{
  "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

language	none

{
  "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

Example - Create an incident from a ticket

This background task is not normally executed directly, and is instead started by performing a POST request to 'StartCreateIncident' Link associated a ticket search result, but it can also be invoked directly as below. Note: TicketId is the internal identifier for the ticket (Issue) and is not the publicly visible 'Key' for the ticket.

Request Headers

Key	Value	Description
Accept	application/json
Content-type	application/json

Request Body

Code Block

language	none

{
  "Type": "CreateTicketLink",
  "Parameters": {
    "TicketId": "12345",
    "ExternalSystemLinkId": "3aaf3505-85ca-43c4-a822-fe468118aab7"
  }
}

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8
Location	http://localhost/api/ticketlinking_d58d140f-fdd5-4d3e-b08b-4629b0b02da5

Response Body

Code Block

language	none

{
  "Complete": false,
  "TotalElements": 2,
  "ProcessedElements": 1,
  "StartedAt": "2011-12-31T21:50:00Z",
  "ProgressInPercent": 0.34,
  "Id": "ticketlinking_d58d140f-fdd5-4d3e-b08b-4629b0b02da5",
  "Message": "Creating incident",
  "Self": "http://localhost/api/backgroundtask/ticketlinking_d58d140f-fdd5-4d3e-b08b-4629b0b02da5"
}

Status Code

202 - Accepted

Child pages

Versions Compared

Old Version 3

New Version Current

Key

Resource: Background Tasks ( /api/backgroundtasks )

Methods

POST

Required Permissions

Status Codes

Child pages

Page History

Versions Compared

Old Version 3

New Version Current

Key

Resource: Background Tasks ( /api/backgroundtasks )

Methods

POST

Required Permissions

Status Codes