See all operations

GET: projects/{project_id}/source-code/{branch_id}/files/{file_id}

Description

Retrieves a specific file by its ID

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/v7_0/RestService.svc/projects/{project_id}/source-code/{branch_id}/files/{file_id}

Request Parameters

Name	Description
project_id	The id of the project
branch_id	The id of the branch (please replace any "/" characters with "..")
file_id	The id of the file

Request Body

Nothing Expected

Nothing Expected

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
Id	The file's unique key.
Name	The full filename
ParentFolder	The parent folder, if it has one.
Size	The size of the file, in bytes.
AuthorName	The name of the file's author
LastRevision	The most recent revision of the file
LastUpdateDate	The last update date/time
Action	The name of the last action performed on the file
Path	The file's path (usually the connection string + any sub directories.
LinkedArtifacts	Any artifacts this file is linked to

<RemoteSourceCodeFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <Action i:nil="true" />
  <AuthorName i:nil="true" />
  <Id i:nil="true" />
  <LastRevision i:nil="true" />
  <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
  <LinkedArtifacts i:nil="true" />
  <Name i:nil="true" />
  <ParentFolder i:nil="true" />
  <Path i:nil="true" />
  <Size>0</Size>
</RemoteSourceCodeFile>

{"Id":null,
"Name":null,
"ParentFolder":null,
"Size":0,
"AuthorName":null,
"LastRevision":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"Action":null,
"Path":null,
"LinkedArtifacts":null}