Jump to

• Request
• Response

Get link summary for request ID

get

/serviceapi/apm.dataserver/api/v1/requests/{id}/operationLinks

Retrieve list of link summary data for a known request ID

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of request (see Get requests or similar). For more information see Object ID Parameters.

Query Parameters

• calledOperationGenre(optional): string
  Called operation type genre (e.g. JDBC)
• includeDownstream(optional): string
  Set to true to include downstream links [default = false]

  Default Value: false
• limit(optional): integer(int32)
  Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
• offset(optional): integer(int32)
  Offset into result set at which to start returning data, useful for paging [default = 0].
• orderBy(optional): string
  Comma-separated list of one or more attributes by which the result set is ordered [default = null]. For more information see Sorting. Use attribute or attribute:asc or attribute:desc. Valid attributes can be found by using Get resource metadata with metadataType = OrderBy and metadataQuery resource = /operationLinks
• q(optional): string
  Query clause of one or more predicates to restrict the result set to those objects satisfying the clause [default = null]. For more information see Filtering. Use query like predicates, such as attribute<=value< code>. Multiple predicates should be parenthesized and joined by AND or OR. Valid attributes can be found by using Get resource metadata with metadataType = Filter and metadataQuery resource = /operationLinks
• 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 OperationLinkType
  Information about a Link to an Operation (OperationLinkType)

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

Nested Schema : OperationLinkType

Type: object

Information about a Link to an Operation (OperationLinkType)

Show Source

• appServerId(optional): integer(int64)
• appServerLongKey(optional): string
• averageOperationResponseTime(optional): number
• averageResponseTime(optional): number
• averageSelfTime(optional): number
• calledOpGenre(optional): string
• calledOpId(optional): integer(int64)
• calledOpLongKey(optional): string
• calledOpName(optional): string
• callerOpId(optional): integer(int64)
• callerOpLongKey(optional): string
• callerOpName(optional): string
• callerSqlId(optional): string
• callType(optional): string
• completedCount(optional): integer(int64)
• errorPercentage(optional): number
• failureCount(optional): integer(int64)
• isExternal(optional): boolean
  Default Value: false
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• loadRate(optional): number
• maxOperationResponseTime(optional): integer(int64)
• maxResponseTime(optional): integer(int64)
• maxSelfTime(optional): integer(int64)
• minOperationResponseTime(optional): integer(int64)
• minResponseTime(optional): integer(int64)
• minSelfTime(optional): integer(int64)
• operationTier(optional): string
• queryTimeRange(optional): object TimeRange
• requestId(optional): integer(int64)
• requestLongKey(optional): string
• totalOperationResponseTime(optional): integer(int64)
• totalResponseTime(optional): integer(int64)
• totalSelfTime(optional): integer(int64)
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "isExternal":{
            "type":"boolean",
            "default":false
        },
        "callType":{
            "type":"string"
        },
        "maxSelfTime":{
            "type":"integer",
            "format":"int64"
        },
        "minSelfTime":{
            "type":"integer",
            "format":"int64"
        },
        "totalSelfTime":{
            "type":"integer",
            "format":"int64"
        },
        "averageSelfTime":{
            "type":"number"
        },
        "errorPercentage":{
            "type":"number"
        },
        "loadRate":{
            "type":"number"
        },
        "minResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "appServerId":{
            "type":"integer",
            "format":"int64"
        },
        "appServerLongKey":{
            "type":"string"
        },
        "completedCount":{
            "type":"integer",
            "format":"int64"
        },
        "failureCount":{
            "type":"integer",
            "format":"int64"
        },
        "totalResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "averageResponseTime":{
            "type":"number"
        },
        "requestLongKey":{
            "type":"string"
        },
        "callerOpId":{
            "type":"integer",
            "format":"int64"
        },
        "callerOpLongKey":{
            "type":"string"
        },
        "callerOpName":{
            "type":"string"
        },
        "callerSqlId":{
            "type":"string"
        },
        "calledOpId":{
            "type":"integer",
            "format":"int64"
        },
        "calledOpLongKey":{
            "type":"string"
        },
        "calledOpName":{
            "type":"string"
        },
        "operationTier":{
            "type":"string"
        },
        "calledOpGenre":{
            "type":"string"
        },
        "totalOperationResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxOperationResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "minOperationResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "averageOperationResponseTime":{
            "type":"number"
        },
        "requestId":{
            "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 Link to an Operation (OperationLinkType)"
}

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