Jump to

• Request
• Response

Retrieve Status of Agent Groups

get

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

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

Request

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• 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'}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8
• application/vnd.oracle.resource+json;type=collection

200 Response

Successful operation

Body ()

Root Schema : AgentGroupsMonitoringRs

Type: object

Show Source

• id: string
• items: array items
• links: array links
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AgentGroupMonitoringRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object AgentGroupMonitoringRs

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AgentGroupMonitoringRs"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : AgentGroupMonitoringRs

Type: object

Show Source

• agents: array agents
• createdBy: string
• createdDate: string(date-time)
• description: string
• displayStatus: string
• id: string
• lastUpdatedBy: string
• lastUpdatedDate: string(date-time)
• links: array links
• name: string
• status: string
  Allowed Values: [ "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE", "NOT_APPLICABLE" ]
• type: string
  Allowed Values: [ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ADAPTER_AGENT",
                "EXECUTION_AGENT"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "AVAILABLE",
                "UNAVAILABLE",
                "PARTIALLY_AVAILABLE",
                "NOT_APPLICABLE"
            ]
        },
        "displayStatus":{
            "type":"string"
        },
        "agents":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AgentMonitoringRs"
            }
        }
    }
}

Nested Schema : agents

Type: array

Show Source

• Array of: object AgentMonitoringRs

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AgentMonitoringRs"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : AgentMonitoringRs

Type: object

Show Source

• agentGroupCode: string
• createdBy: string
• createdDate: string(date-time)
• description: string
• displayStatus: string
• id: string
• lastLockedBy: string
• lastLockedDate: string(date-time)
• lastUpdatedBy: string
• lastUpdatedDate: string(date-time)
• links: array links
• name: string
• status: string
  Allowed Values: [ "REGISTERED", "ACTIVE", "UNAVAILABLE" ]
• type: string
  Allowed Values: [ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastLockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastLockedBy":{
            "type":"string"
        },
        "agentGroupCode":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ADAPTER_AGENT",
                "EXECUTION_AGENT"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "REGISTERED",
                "ACTIVE",
                "UNAVAILABLE"
            ]
        },
        "displayStatus":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top