SpiraPlan: ImportExport SOAP Web Service
See all operations
System_GetArtifactUrl
Description
Returns the application-relative URL to a particular artifact in the system
Parameters
| Type | Name | Required |
|---|---|---|
| int | navigationLinkId - 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 | Yes |
| int | projectId - 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. | Yes |
| int | artifactId - The ID of the artifact. Ignored if not needed, specifying -2 will insert the token {art} for the ArtifactID | Yes |
| string? | tabName - The name of the tab or extra item in the URL. Null if not specified. |
Return Value
string - String of the new URL. It includes the ~ character to represent the application root