# Retrieve Self Service Portal Detailed View Report Retrieves the detailed Self Service Portal view with deployment status information. ## Endpoint `GET /dcapi/patch/reports/SSPDetailedView` ## Request URL `https://`[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/dcapi/patch/reports/SSPDetailedView` ## Scope `DesktopCentralCloud.PatchMgmt.READ` ## Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ## Request Parameters ### Request Headers - **Accept** `string` — **Mandatory** - `application/SSPDetailedView.v1+json` ### Query Parameters - **pageLimit** `integer` — Optional - Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25. - **page** `integer` — Optional - Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1. - **searchColumn** `string` — Optional - Name of the column in which the search value needs to be looked up. Use together with searchValue. - **searchValue** `string` — Optional - Text to look up in the column given in searchColumn. Use together with searchColumn. - **severity** `string` — Optional - Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical. Multiple values can be given as a comma-separated list. - **bullteinID** `string` — Optional - Returns only the deployments of patches released under the given bulletins. A bulletin is the vendor advisory a patch is published under, for example MS15-041. Multiple Bulletin IDs can be given as a comma-separated list. Get the bulletin ID from [Get Supported Patches](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-report-get-supported-patches-report.html). - **deployedDate** `string` — Optional - Returns only the patches deployed on the given date. Provide the date and time as epoch milliseconds. Multiple values can be given as a comma-separated list. - **computerName** `string` — Optional - Returns only the systems whose name contains the given text. - **domain** `string` — Optional - Returns only the systems that belong to the given domain or workgroup. Provide the domain name as shown in Endpoint Central, for example, the NetBIOS name of the domain. Multiple values can be given as a comma-separated list. Get the domain names from [Get Domains](https://www.manageengine.com/products/desktop-central/help/api/cloud/domains-list-domains.html) api. - **servicePack** `string` — Optional - Returns only the systems that have the given service pack or OS build installed. - **operatingSystem** `string` — Optional - Returns only the systems running the given operating system. Provide the operating system name, for example, Windows 11. Multiple values can be given as a comma-separated list. ## Sample Request ### Curl ```curl curl --request GET \ --url https://appdomains/dcapi/patch/reports/SSPDetailedView \ --header 'Accept: application/SSPDetailedView.v1+json' \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 Response Body — `application/json` - `JSON Object` - **Links** `JSON Object` - Pagination links for next and previous pages. - **messageResponse** `JSON Array` - Array of SSP detailed view entries. - **metadata** `JSON Object` - Pagination metadata. - **status** `string` - Operation result: success. - **totalPages** `string` - Total number of pages available. - **totalRecords** `string` - Total number of records matching the query. ### HTTP Code 401 Response Body — `application/json` - `JSON Object` - **errorCode** `long` - Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required). - **errorMsg** `string` - Authentication failure reason. ### HTTP Code 403 Response Body — `application/json` - `JSON Object` - **errorCode** `long` - Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin). - **errorMsg** `string` - Message indicating insufficient privileges to access this resource. ### HTTP Code 429 Response Body — `application/json` - `JSON Object` - **errorCode** `long` - Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes. - **errorMsg** `string` - Rate limit exceeded message with retry guidance. ### HTTP Code 500 Response Body — `application/json` - `JSON Object` - **error_code** `string` - Error code: INTERNAL_ERROR for server-side failures. - **error_description** `string` - Localized error description: dc.rest.api_internal_error. ## Sample Response: HTTP 200 SSP detailed view ```json { "Links": { "next": null, "prev": null }, "messageResponse": [ { "ApproveStatus": "Approved", "BulletinId": "MS24-DEC3", "ComputerName": "WinMachine1", "DeployedDate": "--", "DeploymentStatus": "--", "Domain": "ZOHOCORP", "OperatingSystem": "Windows 11 Professional Edition (x64)", "PatchDescription": "2024-12 Cumulative Update for Windows 11 Version 23H2 for x64-based Systems (KB5048685) (CVE-2024-49138)", "PatchId": "40280", "PatchStatus": "Missing", "PatchType": "Security Updates", "Remarks": "--", "ServicePack": "Windows 11 Version 23H2 (x64)", "Severity": "Critical" }, { "ApproveStatus": "Approved", "BulletinId": "MS22-JAN14", "ComputerName": "WinMachine1", "DeployedDate": "--", "DeploymentStatus": "--", "Domain": "ZOHOCORP", "OperatingSystem": "Windows 11 Professional Edition (x64)", "PatchDescription": "KB5009719, 2022-01 Security and Quality Rollup for .NET Framework 4.5.2 for Windows 7 for x64 (KB5008860) (ESU)", "PatchId": "32830", "PatchStatus": "Missing", "PatchType": "Rollups", "Remarks": "--", "ServicePack": "Windows 11 Version 23H2 (x64)", "Severity": "Important" } ], "metadata": { "limit": 25, "page": 1 }, "status": "success", "totalPages": 1, "totalRecords": 2 } ``` ## Sample Response: HTTP 401 Authentication credentials are missing, expired or invalid ```json { "error_code": "UAC_UNAUTHORIZED", "error_description": "dc.rest.authentication.unauthorized" } ``` ## Sample Response: HTTP 403 Authenticated user lacks the required role or scope ```json { "errorCode": "FORBIDDEN", "errorMessage": "You do not have sufficient privileges to perform this operation" } ``` ## Sample Response: HTTP 429 API call threshold exceeded ```json { "errorCode": "RATE_LIMIT_EXCEEDED", "errorMessage": "API call limit exceeded. Retry after the lock period elapses" } ``` ## Sample Response: HTTP 500 Server-side error ```json { "error_code": "INTERNAL_ERROR", "error_description": "dc.rest.api_internal_error" } ``` ![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **Duration:** 1 minute | **Threshold:** 50 | **Lock period:** 5 minutes Duration - Time window for the threshold. Threshold - Number of API calls allowed within the specified duration. Lock Period - Wait time before consecutive API requests.