Jump to

• Request
• Response

Get logical requests by ID

get

/serviceapi/apm.dataserver/api/v1/applications/{applicationName}/logicalServerRequests/{id}

Retrieve a list of logical requests by ID

Request

Supported Media Types

• application/json

Path Parameters

• applicationName: string
  Name of an application (see Get application definitions or similar). For more information about named path parameters see Object ID Parameters.
• id: string

Query Parameters

• aggregationPeriod(optional): integer(int32)
  Aggregation period applied to time range between the since and until parameters. This parameter's value is in 1-minute units. The default time series aggregation period is 60 minutes. Each bucket in the returned time series data represents the number of minutes in the aggregation period. See Time Series for more details.
• includeTimeseries(optional): boolean
  Aggregation period applied to time range between the since and until parameters. This parameter's value is in 1-minute units. The default time series aggregation period is 60 minutes. Each bucket in the returned time series data represents the number of minutes in the aggregation period. See Time Series for more details.
• since: string
  Retrieve results from start of time period, format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (e.g. 2015-11-23T22:11:05.000Z). For more information see Since and Until Time Range.
• until: string
  Retrieve results until end of time period, format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Back to Top

Response

Supported Media Types

• application/json

200 Response

Completed successfully, list may be empty. See Status Codes for information about other possible HTTP response status codes.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RequestType
  Information about a Server Request (RequestType)

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

Nested Schema : RequestType

Type: object

Information about a Server Request (RequestType)

Show Source

• adminServerHost(optional): string
• adminServerPort(optional): integer(int64)
• agentName(optional): string
• appServerId(optional): integer(int64)
• appServerLongKey(optional): string
• appServerName(optional): string
• appServerPort(optional): integer(int64)
• appServerPortsList(optional): string
• appServerSslPort(optional): integer(int64)
• averageAppServerTime(optional): number
• averageDatabaseTime(optional): number
• averageExternalTime(optional): number
• averageResponseTime(optional): number
• averageSelfTime(optional): number
• completedCount(optional): integer(int64)
• deploymentName(optional): string
• errorPercentage(optional): number
• failureCount(optional): integer(int64)
• flowStart(optional): boolean
  Default Value: false
• hasCallerInfo(optional): boolean
  Default Value: false
• id(optional): integer(int64)
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• loadRate(optional): number
• longKey(optional): string
• maxAppServerTime(optional): integer(int64)
• maxDatabaseTime(optional): integer(int64)
• maxExternalTime(optional): integer(int64)
• maxResponseTime(optional): integer(int64)
• maxSelfTime(optional): integer(int64)
• meId(optional): string
• minAppServerTime(optional): integer(int64)
• minDatabaseTime(optional): integer(int64)
• minExternalTime(optional): integer(int64)
• minResponseTime(optional): integer(int64)
• minSelfTime(optional): integer(int64)
• operationGenre(optional): string
• operationName(optional): string
• queryTimeRange(optional): object TimeRange
• requestId(optional): integer(int64)
• serverName(optional): string
• totalAppServerTime(optional): integer(int64)
• totalDatabaseTime(optional): integer(int64)
• totalExternalTime(optional): integer(int64)
• totalResponseTime(optional): integer(int64)
• totalSelfTime(optional): integer(int64)
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "appServerName":{
            "type":"string"
        },
        "appServerId":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"appserverVersionId"
            }
        },
        "appServerLongKey":{
            "type":"string",
            "xml":{
                "name":"appserverVersionLongKey"
            }
        },
        "appServerPort":{
            "type":"integer",
            "format":"int64"
        },
        "appServerSslPort":{
            "type":"integer",
            "format":"int64"
        },
        "appServerPortsList":{
            "type":"string"
        },
        "adminServerHost":{
            "type":"string",
            "xml":{
                "name":"appServerAdminHost"
            }
        },
        "adminServerPort":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"appServerAdminPort"
            }
        },
        "deploymentName":{
            "type":"string"
        },
        "meId":{
            "type":"string"
        },
        "agentName":{
            "type":"string"
        },
        "flowStart":{
            "type":"boolean",
            "default":false
        },
        "maxSelfTime":{
            "type":"integer",
            "format":"int64"
        },
        "minSelfTime":{
            "type":"integer",
            "format":"int64"
        },
        "totalSelfTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxAppServerTime":{
            "type":"integer",
            "format":"int64"
        },
        "minAppServerTime":{
            "type":"integer",
            "format":"int64"
        },
        "totalAppServerTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxDatabaseTime":{
            "type":"integer",
            "format":"int64"
        },
        "minDatabaseTime":{
            "type":"integer",
            "format":"int64"
        },
        "totalDatabaseTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxExternalTime":{
            "type":"integer",
            "format":"int64"
        },
        "minExternalTime":{
            "type":"integer",
            "format":"int64"
        },
        "totalExternalTime":{
            "type":"integer",
            "format":"int64"
        },
        "averageSelfTime":{
            "type":"number"
        },
        "averageAppServerTime":{
            "type":"number"
        },
        "averageDatabaseTime":{
            "type":"number"
        },
        "averageExternalTime":{
            "type":"number"
        },
        "errorPercentage":{
            "type":"number"
        },
        "loadRate":{
            "type":"number"
        },
        "hasCallerInfo":{
            "type":"boolean",
            "default":false
        },
        "minResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "longKey":{
            "type":"string"
        },
        "completedCount":{
            "type":"integer",
            "format":"int64"
        },
        "failureCount":{
            "type":"integer",
            "format":"int64"
        },
        "totalResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "averageResponseTime":{
            "type":"number"
        },
        "requestId":{
            "type":"integer",
            "format":"int64"
        },
        "operationName":{
            "type":"string"
        },
        "operationGenre":{
            "type":"string"
        },
        "serverName":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "linkCollection":{
            "type":"array",
            "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "queryTimeRange":{
            "description":"Integer query time range used by server to run user query; see <a href='QP_Since_and_Until_Time_Range.html'>Since and Until Time Range</a> for more information",
            "$ref":"#/definitions/TimeRange"
        },
        "warnings":{
            "type":"array",
            "description":"Informational or Error messages",
            "items":{
                "$ref":"#/definitions/ErrorMessage"
            }
        }
    },
    "description":"Information about a Server Request (RequestType)"
}

Nested Schema : linkCollection

Type: array

See Links to Related Resources for more information

Show Source

• Array of: object Link
  Information about a Link to a resource

{
    "type":"array",
    "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeRange

Type: object

Show Source

• sinceTime(optional): integer(int64)
  Results are returned *since* this timestamp
• timeInMinutes(optional): integer(int64)
• untilTime(optional): integer(int64)
  Results are returned *until* this timestamp

{
    "type":"object",
    "properties":{
        "timeInMinutes":{
            "type":"integer",
            "format":"int64"
        },
        "sinceTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *since* this timestamp"
        },
        "untilTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *until* this timestamp"
        }
    }
}

Nested Schema : warnings

Type: array

Informational or Error messages

Show Source

• Array of: object ErrorMessage
  An error message

{
    "type":"array",
    "description":"Informational or Error messages",
    "items":{
        "$ref":"#/definitions/ErrorMessage"
    }
}

Nested Schema : Link

Type: object

Information about a Link to a resource

Show Source

• baseUrl(optional): string
  The base URL for the link
• href: string
  The href portion of the link
• post(optional): string
  The post data of the link
• rel: string
  The relationship name of the link

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship name of the link"
        },
        "href":{
            "type":"string",
            "description":"The href portion of the link"
        },
        "baseUrl":{
            "type":"string",
            "description":"The base URL for the link"
        },
        "post":{
            "type":"string",
            "description":"The post data of the link"
        }
    },
    "description":"Information about a Link to a resource"
}

Nested Schema : ErrorMessage

Type: object

An error message

Show Source

• detail: string
  A detailed description of the error
• errorType(optional): string
  Allowed Values: [ "INFO", "WARNING", "VALIDATION", "ERROR" ]

  The error type
• message: string
  The error message

{
    "type":"object",
    "required":[
        "detail",
        "message"
    ],
    "properties":{
        "errorType":{
            "type":"string",
            "description":"The error type",
            "enum":[
                "INFO",
                "WARNING",
                "VALIDATION",
                "ERROR"
            ]
        },
        "message":{
            "type":"string",
            "description":"The error message"
        },
        "detail":{
            "type":"string",
            "description":"A detailed description of the error"
        }
    },
    "description":"An error message"
}

Back to Top