AuditDashboard Developer Portal
    • AuditDashboard API v1
      • AuditDashboard Developer Portal
      • Clients
        • Get All Clients
        • Create Clients
        • Update Clients
        • Deactivate Clients
        • Activate Clients
        • Client Details
        • Update Client
        • Deactivate Client
        • Activate Client
      • Divisions
        • Get Active Divisions
      • Engagements
        • Get Engagements by Status
        • Create Engagements
        • Update Engagement
        • Update Engagement Statuses
        • Delete Engagements
        • Get Engagement Details
        • Update Engagement
        • Update Engagement Status
        • Delete Engagement
        • Download Engagement Documents
        • Download Engagement Request Report
        • Download 'All Engagements' Report
        • /api/public/engagements/{engagementID}/activityFeed
        • /api/public/engagements/{engagementID}/requestlistreportdata
      • Insights
        • Get Engagement Activity Log Parameters
        • Engagement Activity Log
        • Get Engagement by Last Activity Report Parameters
        • Engagement by Last Activity
        • Get Active Professional Users for Schedule
        • User Activity and Status
        • Schedule
      • Requests
        • Get Engagement Requests
        • Get Request by ID
        • Update Request Details
        • Update Request Status and Priority
        • Delete Request
        • Create Requests
        • Update Multiple Requests
        • Update Request Status and Priority
        • Delete Multiple Requests
        • Get Request History Feed
        • Get Request Activity Feed
        • Add Comment to Request
        • Delete a Request Comment
        • Delete a Request Document
        • Download Request Documents
        • Update Multiple Request Restrictions
        • Update Single Request Restrictions
        • Upload Request Document
      • Users
        • Get Users by Status
        • Create Users
        • Update Multiple Users
        • Deactivate Users
        • Activate Users
        • Get User Details
        • Update User Details
        • Deactivate User
        • Activate User
        • Invite Users
        • Generate User Activity Report
      • Authorization
        • Authorization call for Bearer Token
      • Trash
        • Get Trash Types
        • Get Trash List
        • Restore Trash Items
        • Permanently deletes trash items.
        • Restore a Trash Item
        • Permanently deletes a trash item.
      • Files
        • List Containers
        • Set Container Notifications
        • List Folders in Container
        • List Files in Container Root
        • List Files in Folder
        • Share File or Folder
        • Unshare File or Folder
        • Download File
        • Download Folder Contents
        • Create Download Group
      • Schemas
        • Schemas
        • v2
        • v1
        • APICompanyCreateModel
        • APICompanyModel
        • APICompanyUpdateModel
        • APIEngagementActivityLogModel
        • APIContainerModel
        • APIEngagementCreateModel
        • APIEngagementModel
        • APIEngagementMonthlyReportModel
        • APIEngagementUpdateModel
        • APIEngagementUser
        • APIRequestCreateModel
        • APIRequestModel
        • APIFileModel
        • APIRequestRestricModel
        • APIFolderModel
        • APIRequestUpdateModel
        • APIUserCreateModel
        • APITrashModel
        • APIUserModel
        • APIUserUpdateModel
        • AuthenticationProvider
        • APIShareRequestModel
        • ETag
        • EngagementNotificationType
        • EngagementStatus
        • FeedItem
        • FeedType
        • AccessType
        • MultiFactorType
        • AddressFamily
        • NotificationFrequency
        • AsnEncodedData
        • ProblemDetails
        • Assembly
        • RegistrationStatus
        • AsymmetricAlgorithm
        • RequestNotificationType
        • RequestStatus
        • ByteReadOnlyMemory
        • TrackingInfo
        • ByteReadOnlySpan
        • CallingConventions
        • TrashType
        • CancellationToken
        • Claim
        • ClaimsIdentity
        • ClaimsPrincipal
        • ConnectionInfo
        • ConstructorInfo
        • CreateDownloadGroupRequest
        • CustomAttributeData
        • CustomAttributeNamedArgument
        • CustomAttributeTypedArgument
        • EventAttributes
        • EventInfo
        • FieldAttributes
        • FieldInfo
        • FileType
        • GenericParameterAttributes
        • HostString
        • HttpContext
        • HttpRequest
        • HttpResponse
        • ICustomAttributeProvider
        • IIdentity
        • IPAddress
        • IResponseCookies
        • IServiceProvider
        • ISession
        • IntPtr
        • KeySizes
        • LayoutKind
        • MemberInfo
        • MemberTypes
        • MethodAttributes
        • MethodBase
        • MethodImplAttributes
        • MethodInfo
        • Module
        • ModuleHandle
        • Oid
        • ParameterAttributes
        • ParameterInfo
        • PathString
        • PipeWriter
        • PropertyAttributes
        • PropertyInfo
        • PublicKey
        • QueryString
        • RuntimeFieldHandle
        • RuntimeMethodHandle
        • RuntimeTypeHandle
        • SafeWaitHandle
        • SecurityRuleSet
        • SetContainerNotificationsRequest
        • SetContainerNotificationsResponse
        • StringStringKeyValuePair
        • StringStringValuesKeyValuePair
        • StructLayoutAttribute
        • Type
        • TypeAttributes
        • TypeInfo
        • TypeObjectKeyValuePair
        • WaitHandle
        • WebSocketManager
        • X500DistinguishedName
        • X509Certificate2
        • X509Extension
    • AuditDashboard Open API v2
      • Clients
        • Get All Clients
        • Create Clients
        • Update Clients
        • Deactivate Clients
        • Activate Clients
        • Client Details
        • Update Client
        • Deactivate Client
        • Activate Client
      • Users
        • /api/v2/query
        • /api/v2/list
        • Get Users by Status
        • Create Users
        • Update Multiple Users
        • Deactivate Users
        • Activate Users
        • Get User Details
        • Update User Details
        • Deactivate User
        • Activate User
        • Invite Users
        • Generate User Activity Report
      • Divisions
        • Get Active Divisions
      • Engagements
        • Get Engagements by Status
        • Create Engagements
        • Update Engagement
        • Update Engagement Statuses
        • Delete Engagements
        • Get My Engagements
        • Get My Overdue Engagements
        • Get Engagements Ready To Complete
        • Get Engagement Details
        • Update Engagement
        • Update Engagement Status
        • Delete Engagement
        • Duplicate Engagement
        • Download Engagement Documents
        • Get Engagement Activity Feed
        • Download Engagement Request Report
        • Download 'All Engagements' Report
      • Files
        • List Containers
        • Create Company Cabinet
        • Set Container Notifications
        • Update Folder
        • Delete Folder
        • List Folders in Container
        • Create Folder
        • List Files in Container Root
        • Upload File to Container
        • List Files in Folder
        • Upload File to Folder
        • Share File or Folder
        • Unshare File or Folder
        • Delete Cabinet
        • Download File
        • Download Folder Contents
        • Create Download Group
      • Insights
        • Get Engagement by Last Activity Report Parameters
        • Engagement by Last Activity
        • User Activity and Status
      • Me
        • Get Current User
      • Requests
        • Get Engagement Requests
        • Get Requests Pending My Review
        • Get My Requests
        • Get My Overdue Requests
        • Get Requests I've Flagged
        • Get Request by ID
        • Update Request Details
        • Update Request Status and Priority
        • Delete Request
        • Create Requests
        • Update Multiple Requests
        • Update Request Status and Priority
        • Delete Multiple Requests
        • Get Request History Feed
        • Get Request Activity Feed
        • Get Mentionable Users for a Request
        • Add Comment to Request
        • Send Files to Engagement
        • Delete a Request Comment
        • Delete a Request Document
        • Download Request Documents
        • Update Multiple Request Restrictions
        • Update Single Request Restrictions
        • Upload Request Document
      • Trash
        • Get Trash Types
        • Get Trash List
        • Restore Trash Items
        • Restore a Trash Item
      • Schemas
        • AccessType
        • AddressFamily
        • AggregateFunction
        • APIActivityFeedPageModel
        • APIBatchItemResult
        • APICompanyCreateModel
        • APICompanyModel
        • APICompanyUpdateModel
        • APIContainerCreateModel
        • APIContainerModel
        • APIDivisionModel
        • APIEngagementAutomationsModel
        • APIEngagementCreateModelV2
        • APIEngagementDuplicateModelV2
        • APIEngagementModelV2
        • APIEngagementMonthlyReportModel
        • APIEngagementSummaryModelV2
        • APIEngagementUpdateModelV2
        • APIEngagementUser
        • APIFeedItemModel
        • APIFileModel
        • APIFileTransferRequestModel
        • APIFileTransferResponseModel
        • APIFileTransferResultModel
        • APIFolderCreateModel
        • APIFolderModel
        • APIFolderUpdateModel
        • APIMeDivisionModel
        • APIMeModel
        • APIMentionableUserModel
        • APIMeRoleModel
        • APIRequestCreateModel
        • APIRequestModel
        • APIRequestRestricModel
        • APIRequestUpdateModel
        • APIShareRequestModel
        • APIStatusModel
        • APITrashModel
        • APIUserCreateModel
        • APIUserModel
        • APIUserUpdateModel
        • AsnEncodedData
        • AsymmetricAlgorithm
        • AuthenticationProvider
        • AutomationTrigger
        • BatchItemOutcome
        • CalculationExpression
        • CalculationOperator
        • CancellationToken
        • Claim
        • ClaimsIdentity
        • ClaimsPrincipal
        • ColumnFormatOptions
        • ColumnInfo
        • ConnectionInfo
        • CreateDownloadGroupRequest
        • EngagementNotificationType
        • EngagementStatus
        • ETag
        • FeedItem
        • FeedType
        • FileType
        • HostString
        • HttpContext
        • HttpRequest
        • HttpResponse
        • IFormFile
        • IIdentity
        • IPAddress
        • IResponseCookies
        • IServiceProvider
        • ISession
        • KeySizes
        • KeyValuePairOfstringAndstring
        • KeyValuePairOfstringAndStringValues
        • KeyValuePairOfTypeAndObject
        • MultiFactorType
        • NotificationFrequency
        • ObjectReference
        • Oid
        • PagedResultOfAPICompanyModel
        • PagedResultOfAPIContainerModel
        • PagedResultOfAPIEngagementModelV2
        • PagedResultOfAPIEngagementSummaryModelV2
        • PagedResultOfAPIFileModel
        • PagedResultOfAPIFolderModel
        • PagedResultOfAPIRequestModel
        • PagedResultOfAPIUserModel
        • PathString
        • Permission
        • PermissionList
        • PermissionType
        • PipeReader
        • PipeWriter
        • ProblemDetails
        • PublicKey
        • QueryColumn
        • QueryRequest
        • QueryString
        • ReadOnlyMemoryOfbyte
        • RequestNotificationType
        • RequestStatus
        • SafeWaitHandle
        • SetContainerNotificationsRequest
        • SetContainerNotificationsResponse
        • SqlDbType
        • Stream
        • TableInfo
        • TrackingInfo
        • TrashType
        • Type
        • WaitHandle
        • WebSocketManager
        • X500DistinguishedName
        • X509Certificate2
        • X509Extension

    APIStatusModel

    Self-describing status value for API responses (#5239). The API serializes enums as bare
    integers, so a caller reading "Status": 1 had no way to know it means Confirmed. Every
    entity status now emits { "Value": 1, "Name": "Confirmed" } instead.
    The implicit conversions are what keep the change to the response models a one-line type
    swap: every existing Status = entity.Status assignment still compiles.

    {
        "value": 0,
        "name": "string"
    }
    Built with