SpiraTeam: REST Web Service (v4.0)

See all operations

POST: projects/{project_id}/associations

Description

Adds a new association in the system

How to Execute

To access this REST web service, you need to use the following URL:

http://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/associations

Request Parameters

Name Description
project_id The ID of the current project

Request Body

Property Description
ArtifactLinkId The id of the association/link
SourceArtifactId The artifact id being linked FROM
SourceArtifactTypeId The type of artifact being linked FROM
DestArtifactId The artifact id being linked TO
DestArtifactTypeId The type of artifact being linked TO
CreatorId The user creating the association/link If not specified, the authenticated user is used
Comment A comment that describes the association in more detail
CreationDate The date/time the association was created
DestArtifactName The display name of the artifact being linked to
DestArtifactTypeName The display name of the type of artifact being linked to
CreatorName The display name of the user that created the association/link

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
ArtifactLinkId The id of the association/link
SourceArtifactId The artifact id being linked FROM
SourceArtifactTypeId The type of artifact being linked FROM
DestArtifactId The artifact id being linked TO
DestArtifactTypeId The type of artifact being linked TO
CreatorId The user creating the association/link If not specified, the authenticated user is used
Comment A comment that describes the association in more detail
CreationDate The date/time the association was created
DestArtifactName The display name of the artifact being linked to
DestArtifactTypeName The display name of the type of artifact being linked to
CreatorName The display name of the user that created the association/link