See all operations
POST: projects/{project_id}/automation-hosts/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}
Description
Retrieves the list of automation hosts in the current 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/v5_0/RestService.svc/projects/{project_id}/automation-hosts/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the current project
|
|
starting_row
|
The starting row (1-based)
|
|
number_of_rows
|
The number of rows to retrieve
|
|
sort_field
|
The field to sort by
|
|
sort_direction
|
The direction to sort by [ASC|DESC]
|
Request Body
<ArrayOfRemoteFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<RemoteFilter>
<DateRangeValue i:nil="true" />
<IntValue i:nil="true" />
<MultiValue i:nil="true" />
<PropertyName i:nil="true" />
<StringValue i:nil="true" />
</RemoteFilter>
</ArrayOfRemoteFilter>
[{"DateRangeValue":null,
"IntValue":null,
"MultiValue":null,
"PropertyName":null,
"StringValue":null}]��������������������������������������������������������������������������������������������������������������������������������������������������������������
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.
<ArrayOfRemoteAutomationHost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<RemoteAutomationHost>
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CustomProperties i:nil="true" />
<IsAttachments>false</IsAttachments>
<ProjectId 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>
</ArrayOfRemoteAutomationHost>
[{"ArtifactTypeId":0,
"ConcurrencyDate":"\/Date(-62135578800000-0500)\/",
"CustomProperties":null,
"IsAttachments":false,
"ProjectId":null,
"Active":false,
"AutomationHostId":null,
"Description":null,
"LastContactDate":null,
"LastUpdateDate":"\/Date(-62135578800000-0500)\/",
"Name":null,
"Token":null}]