Jump to

• Request
• Response
• Examples

Retrieve Status of Agent Groups

get

/ic/api/integration/v1/monitoring/agentgroups

Retrieves monitoring data for all agent groups including current availability status.

Request

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
• orderBy: string

  Orders results by name or last updated time.

  Examples:

  /agentgroups?orderBy=time

  /agentgroups?orderBy=name

• q: string

  Filters results by agent group name.

  Example:

  {name:'Execution Agents Group'}

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : AgentGroupsMonitoringRs

Type: object

Show Source

• has-more: boolean
  Has More
• items: array items
  List of Agent Group
• limit: integer (int32)
  Limit
• total-results: integer (int32)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Agent Group",
            "items":{
                "$ref":"#/components/schemas/AgentGroupMonitoringRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "description":"Limit",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Has More"
        }
    }
}

Nested Schema : items

Type: array

List of Agent Group

Show Source

• Array of: object AgentGroupMonitoringRs

{
    "type":"array",
    "description":"List of Agent Group",
    "items":{
        "$ref":"#/components/schemas/AgentGroupMonitoringRs"
    }
}

Nested Schema : AgentGroupMonitoringRs

Type: object

Show Source

• agents: array agents
  List of Agents
• created-by: string
  Created By
• created-date: string (date-time)
  Created Date
• description: string
  Description
• display-status: string
  Display Status
• last-updated-by: string
  Last Updated By
• last-updated-date: string (date-time)
  Last Updated Date
• name: string
  Name
• status: string
  Allowed Values: [ "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE" ]
• type: string
  Allowed Values: [ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
• version: string
  Version

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version"
        },
        "name":{
            "type":"string",
            "description":"Name"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created-date":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "last-updated-date":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "type":{
            "$ref":"#/components/schemas/AgentType"
        },
        "status":{
            "$ref":"#/components/schemas/AgentGroupStatus"
        },
        "display-status":{
            "type":"string",
            "description":"Display Status"
        },
        "agents":{
            "type":"array",
            "description":"List of Agents",
            "items":{
                "$ref":"#/components/schemas/AgentMonitoringRs"
            }
        }
    }
}

Nested Schema : agents

Type: array

List of Agents

Show Source

• Array of: object AgentMonitoringRs

{
    "type":"array",
    "description":"List of Agents",
    "items":{
        "$ref":"#/components/schemas/AgentMonitoringRs"
    }
}

Nested Schema : AgentMonitoringRs

Type: object

Show Source

• agent-group-code: string
  Agent Group Code
• created-by: string
  Created By
• created-date: string (date-time)
  Created Date
• description: string
  Description
• display-status: string
  Display Status
• last-locked-by: string
  Last Locked By
• last-locked-date: string (date-time)
  Last Locked Date
• last-updated-by: string
  Last Updated By
• last-updated-date: string (date-time)
  Last Updated Date
• name: string
  Name
• status: string
  Allowed Values: [ "REGISTERED", "ACTIVE", "UNAVAILABLE" ]
• type: string
  Allowed Values: [ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
• version: string
  Version

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version"
        },
        "name":{
            "type":"string",
            "description":"Name"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created-date":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "last-updated-date":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-locked-date":{
            "type":"string",
            "description":"Last Locked Date",
            "format":"date-time"
        },
        "last-locked-by":{
            "type":"string",
            "description":"Last Locked By"
        },
        "agent-group-code":{
            "type":"string",
            "description":"Agent Group Code"
        },
        "type":{
            "$ref":"#/components/schemas/AgentType"
        },
        "status":{
            "$ref":"#/components/schemas/AgentStatus"
        },
        "display-status":{
            "type":"string",
            "description":"Display Status"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve the status of agent groups by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Retrieve Status of Agent Groups

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @runIntegration.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/agentgroups?integrationInstance=service-instance

Back to Top