Report Details

Retrieves detailed information about a specific report, including its status and logs that track the report's processing steps.

Request Parameters

Parameter Name	Required	Description
`reportId`	Yes	The unique identifier of the report whose details are being retrieved.

Response Fields

Field Name	Description
`id`	The unique identifier of the report.
`reportName`	The name of the report.
`reportType`	The category/type of the report.
`status`	The current processing status of the report. Possible values: `PENDING`, `COMPLETE`, `FAILED`.
`reportLogs`	A list of logs detailing each step in the report generation process.

`reportLogs` Object Fields

Field Name	Description
`id`	The unique identifier of the log entry.
`messageLog`	A message describing the log entry.
`status`	The status of the logged step. Possible values: `PENDING`, `COMPLETE`, `FAILED`.
`createdAt`	The timestamp when the log entry was created.
`completedAt`	The timestamp when the log entry was completed (if applicable).

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "id": 13,
    "reportName": "Test Reporter",
    "reportType": "TRANSFERS REPORT",
    "status": "FAILED",
    "reportLogs": [
        {
            "id": 115,
            "messageLog": "sheetName '' is invalid - character count MUST be greater than or equal to 1 and less than or equal to 31",
            "status": "FAILED",
            "createdAt": "2025-01-27T08:24:59.000+00:00",
            "completedAt": null
        },
        {
            "id": 114,
            "messageLog": "Exporting Report To Excel",
            "status": "PENDING",
            "createdAt": "2025-01-27T08:24:58.000+00:00",
            "completedAt": null
        },
        {
            "id": 113,
            "messageLog": "Sorting All Transfers",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:58.000+00:00",
            "completedAt": "2025-01-27T08:24:58.000+00:00"
        },
        {
            "id": 112,
            "messageLog": "Inward Transfers Process Complete",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:58.000+00:00",
            "completedAt": null
        },
        {
            "id": 111,
            "messageLog": "Getting Outward Transfers For ",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:58.000+00:00",
            "completedAt": "2025-01-27T08:24:58.000+00:00"
        },
        {
            "id": 110,
            "messageLog": "Getting Inward Transfers Parameters",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:58.000+00:00",
            "completedAt": "2025-01-27T08:24:58.000+00:00"
        },
        {
            "id": 109,
            "messageLog": "Inward Transfers Process Started",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:58.000+00:00",
            "completedAt": null
        },
        {
            "id": 108,
            "messageLog": "Getting Outward Transfers For ",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:57.000+00:00",
            "completedAt": "2025-01-27T08:24:58.000+00:00"
        },
        {
            "id": 107,
            "messageLog": "Getting Outward Transfers Parameters",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:57.000+00:00",
            "completedAt": "2025-01-27T08:24:57.000+00:00"
        },
        {
            "id": 106,
            "messageLog": "Outward Transfers Process Started",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:57.000+00:00",
            "completedAt": null
        },
        {
            "id": 105,
            "messageLog": "Generating Test Reporter Report",
            "status": "COMPLETE",
            "createdAt": "2025-01-27T08:24:57.000+00:00",
            "completedAt": null
        }
    ]
}

Request Parameters#

Response Fields#

reportLogs Object Fields#

Request

Request samples

Responses

Request Parameters

Response Fields

`reportLogs` Object Fields