See all operations
POST: projects/{project_id}/automation-hosts
Description
Creates a new automation host in the system
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
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the current project
|
Request Body
|
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
The current project is always used for Insert operations for security reasons
|
|
ConcurrencyDate
|
The datetime used to track optimistic concurrency to prevent edit conflicts
|
|
CustomProperties
|
The list of associated custom properties/fields for this artifact
|
<RemoteAutomationHost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<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>
{"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}
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
The current project is always used for Insert operations for security reasons
|
|
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?
|
<RemoteAutomationHost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<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>
{"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}