SpiraPlan: REST Web Service (v6.0)

See all operations

GET: system/artifact-types/{navigation_link_id}/project/{project_id}/artifact/{artifact_id}?tab_name={tab_name}

Description

Returns the application-relative URL to a particular artifact 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/v6_0/RestService.svc/system/artifact-types/{navigation_link_id}/project/{project_id}/artifact/{artifact_id}?tab_name={tab_name}

Request Parameters

Name Description
navigation_link_id The id of the type of page to return. Possible values are: None = -1, Login = -2, MyPage = -3, ProjectHome = -4, Requirements = 1, TestCases = 2, Incidents = 3, Releases = 4, Reports = -5, TestSets = 8, Administration = -6, ErrorPage = -7, MyProfile = -8, Tasks = 6, Iterations = -9, Documents = -10, Resources = -11, ProjectGroupHome = -12, SourceCode = -13, TestRuns = 5, TestSteps = 7, Attachment = -14, TestStepRuns = -15, TestExecute = -16
project_id The project ID of the artifact. Ignored if not needed. Specifying -1 will not include ProjectPath, specifying -2 will insert the token {proj} for the ProjectID.
artifact_id The ID of the artifact. Ignored if not needed, specifying -2 will insert the token {art} for the ArtifactID
tab_name The name of the tab or extra item in the URL. Null if not specified.

Request Body

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
Empty