See all operations

GET: automation-engines/{automation_engine_id}

Description

Retrieves a single automation engine record by its ID

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/Spira/Services/v6_0/RestService.svc/automation-engines/{automation_engine_id}

Request Parameters

Name	Description
automation_engine_id	The id of the engine

Request Body

Nothing Expected

Nothing Expected

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property	Description
AutomationEngineId	The id of the engine
Name	The display name of the engine
Token	The token of the engine Ths is the name that external systems should refer to it as
Description	The detailed description of the engine Optional
Active	Is this host active for the project

<RemoteAutomationEngine xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <Active>false</Active>
  <AutomationEngineId i:nil="true" />
  <Description i:nil="true" />
  <Name i:nil="true" />
  <Token i:nil="true" />
</RemoteAutomationEngine>

{"AutomationEngineId":null,
"Name":null,
"Token":null,
"Description":null,
"Active":false}