Get All Agents

Select

SaaS

Customer Managed

This operation returns a list of agents for a client.

More Details

Query Parameters

• clientId integer required

  ID of the client

• propertyLevel integer

  Possible values: [0, 10, 20, 30]

  Higher the property level more properties are fetched

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• agentProperties object[]

  AgentProperties object

  installDate integer

  agentVersion string

  isMarkedDeleted boolean

  idaActivityControl object

  activityControlOptions object[]

  activityType integer

  enableAfterADelay boolean

  enableActivityType boolean

  idaEntity object

  clientId integer

  clientName string

  appName string

  commCellId integer

  applicationId integer

{
  "agentProperties": [
    {
      "AgentProperties": {
        "installDate": 0,
        "agentVersion": "string",
        "isMarkedDeleted": true
      },
      "idaActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 0,
            "enableAfterADelay": true,
            "enableActivityType": true
          }
        ]
      },
      "idaEntity": {
        "clientId": 0,
        "clientName": "string",
        "appName": "string",
        "commCellId": 0,
        "applicationId": 0
      }
    }
  ]
}

{
  "agentProperties": [
    {
      "AgentProperties": {
        "installDate": 1486138489,
        "agentVersion": "11(BUILD80)",
        "isMarkedDeleted": false
      },
      "idaActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      },
      "idaEntity": {
        "clientId": 2,
        "clientName": "greenvalley",
        "appName": "File System",
        "commCellId": 2,
        "applicationId": 33
      }
    }
  ]
}

Loading...