Get Report Details¶

GET /1.3/reports/{id}

Description¶

Finds a report by its internal or external id.

Parameters¶

Parameter	Required	Default	Description
id	X		TruSTAR report id or external tracking id
idType		`internal`	`internal` or `external`
includeNotes		`false`	Whether to include the report notes in the response. WARNING: Notes are deprecated and will be removed soon. This field has been added to allow clients to export existing notes for historical records.

Response (200)¶

A Report object.

Example Usage¶

Request¶

curl -k -X GET -H "Authorization: Bearer {access_token}" \
   "https://api.trustar.co/api/1.3/reports/1234?idType=external"

Response¶

{
    "id": "b11d4516-9935-4be7-9d6a-4940b564d32e",
    "externalId": "1234",
    "created": 1501175290467,
    "updated": 1501175290467,
    "title": "Downloaded malware today",
    "sector": {
        "name": "health",
        "label": "Health"
    },
    "distributionType": "ENCLAVE",
    "enclaveIds": [
        "08b2a4cd-1c38-4be1-b641-8e5b607e2075",
        "50f6024f-927f-467a-8e61-c443c5a544c3"
    ],
    "timeBegan": 1501175280256,
    "reportBody": "I visited google.com and downloaded malware.exe.",
    "notes": [
        {
            "note": "Interesting.  Did you try deleting the malware?",
            "user": "myuser@mycompany.com",
            "created": 1629822721000,
            "updated": 1629822721000
        }
    ]
}