Device Execution details for specific Run

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the devices Execution details and other details for paritcular run in a deployment. To obtain the deploymentId, use the All Deployments API. To obtain the runID, use the Deployment Runs API. To get sensor object and version IDs use Get Sensor Details. To get workflow object and version IDs use Get workflow Details. In api response module_object_id - The object ID of the deployed resource. module_object_version_id - The version ID of the deployed resource.

Request URL

https://{serverurl}/intelligence/api/deployments/EIDeploymentRunObjectsToDeviceView Copied!

Scope

DesktopCentralCloud.dex.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/DexViewData.v1+jsonapplication/DexViewData.v1+jsonCopied!

- Query Parameters

SEARCH_COLUMNstringOptional

Search Columns
The following columns are available for searching with their respective data types: Resource.NAME (String), BranchOfficeDetails.BRANCH_OFFICE_NAME (String), Resource.DOMAIN_NETBIOS_NAME (String), AgentContact.LOGGED_ON_USERS (String).

To search using a single column, provide one value in SEARCH_COLUMN and the corresponding value in SEARCH_VALUE.
Example:
SEARCH_COLUMN=Resource.NAME
SEARCH_VALUE=Device1

To search using multiple columns, provide comma-separated column names in SEARCH_COLUMN and the corresponding comma-separated values in SEARCH_VALUE in the same order.
Example:
SEARCH_COLUMN=Resource.NAME,OS_NAME
SEARCH_VALUE=Device1,Windows 11

Note: The number of values in SEARCH_VALUE must match the number of columns specified in SEARCH_COLUMN.

SEARCH_VALUEstringOptional

Search Values
Provide the search value(s) corresponding to the column(s) specified in the SEARCH_COLUMN parameter. Multiple values must be provided in the same order as the column names.

deploymentIDstringMandatory

Deployment ID

runIDstringMandatory

Run ID

objectIDstringMandatory

Object ID

objectVersionIDstringMandatory

Object Version ID

objectTypestringMandatory

Object Type 1 for Workflows, 2 for Sensors

pagestringOptional

Page number

pageLimitstringOptional

Number of items per page

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/intelligence/api/deployments/EIDeploymentRunObjectsToDeviceView?deploymentID=SOME_STRING_VALUE&runID=SOME_STRING_VALUE&objectID=SOME_STRING_VALUE&objectVersionID=SOME_STRING_VALUE&objectType=SOME_STRING_VALUE' \
  --header 'Accept: application/DexViewData.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
viewNamestring

Name of this view

totalRecordsstring

Total number of matching records

startIndexstring

Starting position of records in this page

noOfObjstring

Number of records in this page

dataJSON Array

List of per-device execution details

Show Sub-Attributes
JSON Object
Show Sub-Attributes
Resource.NAMEstring

Device name

EIDeploymentExecutionDetails.EXECUTION_STATUSstring

Status of the execution

EIDeploymentExecutionDetails.EXECUTION_TIMEstring

When the execution happened

AgentContact.LAST_CONTACT_TIMEstring

When the device last contacted the server

BranchOfficeDetails.BRANCH_OFFICE_NAMEstring

Remote office location

Resource.DOMAIN_NETBIOS_NAMEstring

Domain of the device

AgentContact.LOGGED_ON_USERSstring

Users currently logged in

EIDeploymentExecutionDetails.REMARKSstring

Additional notes about the execution

Sample Response: HTTP 200

Copied!
  {
    "viewName": "string",
    "totalRecords": "string",
    "startIndex": "string",
    "noOfObj": "string",
    "data": [
      {
        "Resource.NAME": "string",
        "EIDeploymentExecutionDetails.EXECUTION_STATUS": "string",
        "EIDeploymentExecutionDetails.EXECUTION_TIME": "string",
        "AgentContact.LAST_CONTACT_TIME": "string",
        "BranchOfficeDetails.BRANCH_OFFICE_NAME": "string",
        "Resource.DOMAIN_NETBIOS_NAME": "string",
        "AgentContact.LOGGED_ON_USERS": "string",
        "EIDeploymentExecutionDetails.REMARKS": "string"
      }
    ]
  }
                
▼ Show full

Duration: 1 minute | Threshold: 30 | 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.