See all operations

GET: projects/{project_id}/automation-hosts/tokens/{token}

Description

Retrieves a single automation host by its token name

Token names are only unique within a project

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/projects/{project_id}/automation-hosts/tokens/{token}

Request Parameters

Name	Description
project_id	The id of the current project
token	The automation host's token name

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
AutomationHostId	The id of the host
Name	The name of the host
Token	The token of the host Ths is the name that external systems should refer to it as
Description	The detailed description of the host Optional
LastUpdateDate	The date/time that the host was last modified This field needs to match the values retrieved to ensure data-concurrency
Active	Is this host active for the project
LastContactDate	The last time this host was contacted
ProjectId	The id of the project that the artifact belongs to
ArtifactTypeId	The type of artifact that we have
ConcurrencyDate	The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties	The list of associated custom properties/fields for this artifact
IsAttachments	Does this artifact have any attachments?
Tags	The list of meta-tags that should be associated with the artifact

<RemoteAutomationHost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <ArtifactTypeId>0</ArtifactTypeId>
  <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
  <CustomProperties i:nil="true" />
  <IsAttachments>false</IsAttachments>
  <ProjectId>0</ProjectId>
  <Tags i:nil="true" />
  <Active>false</Active>
  <AutomationHostId i:nil="true" />
  <Description i:nil="true" />
  <LastContactDate i:nil="true" />
  <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
  <Name i:nil="true" />
  <Token i:nil="true" />
</RemoteAutomationHost>

{"AutomationHostId":null,
"Name":null,
"Token":null,
"Description":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"Active":false,
"LastContactDate":null,
"ProjectId":0,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null}