DownloadProjectTestCaseWorkspaceNoteFile

This method can be used for the following: Download a project test case workspace note file for a project user has Edit access to.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

GET /api/ss/project/:projectId/testcase-workspace-note/:testcaseWorkspaceNoteId/file/:fileName HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

projectId (string)

Identifier for the project.

Example:

GET /api/ss/project/5f5ebf3b31ff1d08c1e5fa91/testcase-workspace-note/:testcaseWorkspaceNoteId/file/:fileName HTTP/1.1

testcaseWorkspaceNoteId (string)

Identifier for the test case workspace note.

Example:

GET /api/ss/project/:projectId/testcase-workspace-note/656158c0965172000f9119a8/file/:fileName HTTP/1.1

fileName (string)

Storage name for the file.

Example:

GET /api/ss/project/:projectId/testcase-workspace-note/:testcaseWorkspaceNoteId/file/o23kuixb8c34fm4gbehndpwzuemegvufjzc7jfkh5xlrmlswl4smfyslj65vuupcv5cc21hizhiiysa1bh5ibiwio17vzpzr63n6xtfh9yvzso4ete6qyh55ez5o6in1 HTTP/1.1

Example

The following example is a cURL request to get a file on a project test case workspace note.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X GET 'https://demo.attackforge.com/api/ss/project/67cb89a55834139c803e12e8/testcase-workspace-note/67d16a1fbe4f9ef100ff03a6/file/hzib81wyo0xp2xns7di9og990ylc3tfgqxd1yxor7k7n6xswxx98w1eohkvnnrrxgswsvkbqzubisikfezgtac3bqydwi9p0wcjrxjgzhjk8esadnf4kczyakoaedpmt' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains binary data. If using curl, use option --output to save the binary response as a file e.g.

curl <as above> --output image.png