SpiraPlan: REST Web Service (v7.0)

See all operations

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


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):


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

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