Skip Navigation

Search for focus view results

Search for focus views by a list of device ID and
BlackBerry Protect Desktop
event ID pairs, up to 200 at a time. The request requires both a
BlackBerry Protect Desktop
event ID and device ID to determine whether or not a focus view can be created.
Service endpoint
/foci/v2/search
Optional query string parameters
Example
https://protectapi.cylance.com/foci/v2/search
Method
HTTP/1.1 POST
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
    with the opticsfocus:list scope encoded

Request

[ { "uid": "59F849F29BBE4F1F889AAF50F9153618", "device_id": "E378DACB9324453AB8C65A8406952195" } ]

Response

Please see the Response status codes for more information.

Request JSON schema

Field Name
Description
uid
This is the unique ID of a
BlackBerry Protect Desktop
event. This is "value" from Get focus view list.
device_id
This is the unique device ID that the lockdown command was issued to. See About device ID for device ID formatting.

Response JSON schema

Field Name
Description
uid
This is the unique ID of a
BlackBerry Protect Desktop
event.
device_id
This is the unique device ID that the lockdown command was issued to. See About device ID for device ID formatting.
status
This is the status of the focus view result or request. Possible values are:
  • AVAILABLE: A focus view has been generated and is available for viewing.
  • PENDING: The focus view has been requested.
  • REQUEST: The focus view has not been generated, but it can be requested.
  • RETRY_REQUEST: The focus view has not been generated. It was previously requested but no results were received. It can be requested again.
  • DOES_NOT_EXIST: The focus view requested on the device cannot be completed because the requested parameters do not exist on the device.
  • UNAVAILABLE: The focus view is not available, and the associated device is not online to fulfill the request. It can be requested at a later time.
  • UNKNOWN_DEVICE: The focus view is not available, and the associated device is no longer known.
focus_id
This is the unique ID of the focus view.