GetProjectRequestById

This method can be used for the following: Get details for a project request you have access to, by project request identifier (Id).

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/request/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Identifier for the project request.

Example:

GET /api/ss/request/5e8017d2e1385f0c58e8f4f8 HTTP/1.1

cf_key_allowlist (string) (optional)

List of custom field keys to include in response. Add multiple for more than one key e.g. ?cf_key_allowlist=key1&cf_key_allowlist=key2 or specify no keys to exclude all fields e.g. ?cf_key_allowlist=

Example:

GET /api/ss/request/5e8017d2e1385f0c58e8f4f8?cf_key_allowlist=key1&cf_key_allowlist=key2 HTTP/1.1

cf_key_blocklist (string) (optional)

List of custom field keys to exclude from response. Add multiple for more than one key e.g. ?cf_key_blocklist=key1&cf_key_blocklist=key2

Example:

GET /api/ss/request/5e8017d2e1385f0c58e8f4f8?cf_key_blocklist=key1&cf_key_blocklist=key2 HTTP/1.1

Example

The following example is a cURL request to get a project request by its identifier (Id).

Request

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

curl -X GET 'https://demo.attackforge.com/api/ss/request/5e8017d2e1385f0c58e8f4f8' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains a project request object.

{
  "request":{
    "id": "...",
    "project_id": "...",
    "created": "...",
    "last_updated": "...",
    "name": "...",
    "code": "...",
    "status": "...",
    "groups": [
      "..."
    ],
    "scope": [
      "..."
    ],
    "test_types_to_be_performed": [
      "..."
    ],
    "project_start_date": "...",
    "project_end_date": "...",
    "project_testing_hours": "...",
    "onsite_testing_required": "...",
    "reason_for_testing": "...",
    "created_by": "...",
    "supporting_documents": [
      "..."
    ],
    "files": [
      {
        "hash": "...",
        "id": "...",
        "name": "...",
        "size": 999,
        "size_kb": 999,
        "storage_location": "...",
        "storage_name": "...",
        "type": "..."
      }
    ],
    "custom_fields": [
      {
        "key": "...",
        "value": "..."
      }
    ]
  }
}