See all operations
POST: projects/{project_id}/associations/{artifact_type_id}/{artifact_id}/search?sort_by={sort_by}
Description
Retrieves a set of associations to the specified artifact
The source artifact type and id will be the same as the ones passed in
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}/associations/{artifact_type_id}/{artifact_id}/search?sort_by={sort_by}
Request Parameters
Name
|
Description
|
project_id
|
The id of the current project
|
artifact_type_id
|
The id of the artifact type:
(Requirement = 1,
TestCase = 2,
Incident = 3,
Release = 4,
TestRun = 5,
Task = 6,
TestStep = 7,
TestSet = 8)
|
artifact_id
|
The id of the artifact
|
sort_by
|
The sort to apply (Field 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.v6_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>
[{"PropertyName":null,
"IntValue":null,
"StringValue":null,
"MultiValue":null,
"DateRangeValue":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.
<ArrayOfRemoteAssociation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<RemoteAssociation>
<ArtifactLinkId i:nil="true" />
<ArtifactLinkTypeId>0</ArtifactLinkTypeId>
<ArtifactLinkTypeName i:nil="true" />
<Comment i:nil="true" />
<CreationDate i:nil="true" />
<CreatorId i:nil="true" />
<CreatorName i:nil="true" />
<DestArtifactId>0</DestArtifactId>
<DestArtifactName i:nil="true" />
<DestArtifactTypeId>0</DestArtifactTypeId>
<DestArtifactTypeName i:nil="true" />
<SourceArtifactId>0</SourceArtifactId>
<SourceArtifactTypeId>0</SourceArtifactTypeId>
</RemoteAssociation>
</ArrayOfRemoteAssociation>
[{"ArtifactLinkId":null,
"SourceArtifactId":0,
"SourceArtifactTypeId":0,
"DestArtifactId":0,
"DestArtifactTypeId":0,
"ArtifactLinkTypeId":0,
"CreatorId":null,
"Comment":null,
"CreationDate":null,
"DestArtifactName":null,
"DestArtifactTypeName":null,
"CreatorName":null,
"ArtifactLinkTypeName":null}]