Jump to

• Request
• Response

Retrieve Status of an Agent

get

/ic/api/integration/v1/monitoring/agentgroups/{id}/agents/{key}

Retrieves monitoring data including current availability status for an agent in the specified agent group.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• id: string
  Agent group identifier.
• key: string
  Agent identifier.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : AgentMonitoringRs

Type: object

Show Source

• agentGroupCode(optional): string
• createdBy(optional): string
• createdDate(optional): string(date-time)
• description(optional): string
• displayStatus(optional): string
• id(optional): string
• lastLockedBy(optional): string
• lastLockedDate(optional): string(date-time)
• lastUpdatedBy(optional): string
• lastUpdatedDate(optional): string(date-time)
• links(optional): array links
• name(optional): string
• status(optional): string
  Allowed Values: [ "REGISTERED", "ACTIVE", "UNAVAILABLE" ]
• type(optional): string
  Allowed Values: [ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
• version(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): string

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

400 Response

Malformed parameters

500 Response

Server error

Back to Top