Get Request by ID - AuditDashboard Developer Portal

Retrieves a specific request by its unique ID.

Responses

🟢200OK

text/plain

OK: The request was retrieved successfully.

Body

RequestID

integer <int32>

optional

Gets the unique identifier for the request.

EngagementID

integer <int32>

optional

Gets the engagement ID associated with the request.

Title

string | null

optional

Gets the title of the request.

Reference

string | null

optional

Gets the reference code for the request.

Description

string | null

optional

Gets the description of the request.

DueDate

string <date-time> | null

optional

Gets the due date for the request.

HighPriority

boolean

optional

Gets whether the request is marked as high priority.

SendEmailImmediately

boolean | null

optional

Gets whether an email should be sent immediately.

FirmUserID

integer <int32> | null

optional

Gets the firm user ID associated with the request.

ClientUserID

integer <int32> | null

optional

Gets the client user ID associated with the request.

Restricted

boolean

optional

Gets whether the request is restricted.

ExcludeFromDuplication

boolean

optional

Gets whether the request should be excluded from duplication.

GlobalModification

string <date-time>

optional

Gets the global modification timestamp.

Status

enum<integer> <int32>

optional

Allowed values:

0110-100-1

Created

object (TrackingInfo)

optional

integer <int32>

optional

string <date-time>

optional

Modified

object (TrackingInfo)

optional

Access

array[integer <int32>] | null

optional

Gets the list of user IDs who have access to the request.

Comments

array[integer <int32>] | null

optional

Gets the list of comment IDs associated with the request.

Documents

array[integer <int32>] | null

optional

Gets the list of document IDs associated with the request.

Example

{
    "RequestID": 0,
    "EngagementID": 0,
    "Title": "string",
    "Reference": "string",
    "Description": "string",
    "DueDate": "2019-08-24T14:15:22Z",
    "HighPriority": true,
    "SendEmailImmediately": true,
    "FirmUserID": 0,
    "ClientUserID": 0,
    "Restricted": true,
    "ExcludeFromDuplication": true,
    "GlobalModification": "2019-08-24T14:15:22Z",
    "Status": 0,
    "Created": {
        "By": 0,
        "On": "2019-08-24T14:15:22Z"
    },
    "Modified": {
        "By": 0,
        "On": "2019-08-24T14:15:22Z"
    },
    "Access": [
        0
    ],
    "Comments": [
        0
    ],
    "Documents": [
        0
    ]
}

🟠401Unauthorized

🟠404Record Not Found