Show Source

• Array of: object NotificationsDetailResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NotificationsDetailResponse"
    }
}

Show Source

• entityId: string (uuid)
• entityType: string
• messageDescription: string
• messageSubject: string
• notificationsBroadcast: object NotificationsBroadcast

{
    "type":"object",
    "properties":{
        "messageDescription":{
            "type":"string"
        },
        "messageSubject":{
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "type":"string"
        },
        "notificationsBroadcast":{
            "$ref":"#/components/schemas/NotificationsBroadcast"
        }
    }
}

Show Source

• actionId: string (uuid)
• approvalFlag: string
• archiveDateTime(required): string
• category: string
• comment: string
• emailAttemptDateTime: string (date-time)
• id: string (uuid)
• messageReadDateTime(required): string
• notificationDateTime: string
• notificationLogId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• subscription: string
• updatedBy: string (uuid)
• userEmailAddress: string
• userId: string (uuid)
• userName: string
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "archiveDateTime",
        "messageReadDateTime"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "notificationLogId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "userEmailAddress":{
            "type":"string"
        },
        "subscription":{
            "type":"string"
        },
        "messageReadDateTime":{
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "archiveDateTime":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "emailAttemptDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "updatedBy":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "approvalFlag":{
            "type":"string"
        },
        "notificationDateTime":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "actionId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        }
    }
}

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Show Source

• details: string
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

  Example: User role is missing required permission REPORTING_VIEW. Field: userId
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}