Jump to

• Request
• Response
• Examples

Get All Performance Debugger Records

get

/rest/v19/performanceDebugger

Use this endpoint to retrieve a list of performance debugger log records.

Request

Supported Media Types

• application/json

Query Parameters

• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Performance Debugger Collection

Type: object

Title: Performance Debugger Collection

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/performanceDebugger"
            }
        }
    },
    "title":"Performance Debugger Collection"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Performance Debugger
  Title: Performance Debugger

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

Nested Schema : Performance Debugger

Type: object

Title: Performance Debugger

Show Source

• action: object Action
  Title: Action

  Which action this log tests
• description: string
  Title: Description

  Description for this performance log
• error: string
  Title: Error

  Error message if the log execution failed
• id: integer
  Title: Id

  Primary Key of the resource
• referenceLabel: string
  Title: Reference Label

  Describes the subject of this performance log
• status: object Status
  Title: Status

  Whether the log is in progress, finished successfully or has failed.
• time_ms: integer
  Title: Time in Milliseconds

  Total time that the action took to finished executed (in milliseconds).

{
    "type":"object",
    "properties":{
        "action":{
            "type":"object",
            "description":"Which action this log tests",
            "title":"Action",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "description":{
            "type":"string",
            "description":"Description for this performance log",
            "title":"Description"
        },
        "error":{
            "type":"string",
            "description":"Error message if the log execution failed",
            "title":"Error"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        },
        "referenceLabel":{
            "type":"string",
            "description":"Describes the subject of this performance log",
            "title":"Reference Label"
        },
        "status":{
            "type":"object",
            "description":"Whether the log is in progress, finished successfully or has failed.",
            "title":"Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "time_ms":{
            "type":"integer",
            "description":"Total time that the action took to finished executed (in milliseconds).",
            "title":"Time in Milliseconds"
        }
    },
    "title":"Performance Debugger"
}

Nested Schema : Action

Type: object

Title: Action

Which action this log tests

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Which action this log tests",
    "title":"Action",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Status

Type: object

Title: Status

Whether the log is in progress, finished successfully or has failed.

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Whether the log is in progress, finished successfully or has failed.",
    "title":"Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve a list of performance debugger log records by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/performanceDebugger

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com.com/rest/v19/performanceDebugger"
    }
  ],
  "items": [{
      "referenceLabel": "test1:productLine1:model1",
      "description": "configure output test",
      "error": null,
      "action": {
        "lookupCode": "CONFIG_CONFIGURE",
        "displayValue": "Configuration Configure",
        "id": 3023215310,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PERFORMANCE_DEBUGGER_ACTION%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues/3023215310"
          }
        ]
      },
      "id": 3023234038,
      "time": 141,
      "status": {
        "lookupCode": "COMPLETED_SUCCESS",
        "displayValue": "Completed Successfully",
        "id": 3023215314,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PEFORMANCE_DEBUGGER_STATUS%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues/3023215314"
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com.com/rest/v19/performanceDebugger/3023234038"
        }
      ]
    }, {
      "referenceLabel": "testbed:systemConfiguration:rootSystem",
      "description": "configure output test",
      "error": null,
      "action": {
        "lookupCode": "CONFIG_UPDATE",
        "displayValue": "Configuration Update",
        "id": 3023215311,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PERFORMANCE_DEBUGGER_ACTION%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues/3023215311"
          }
        ]
      },
      "id": 3023233987,
      "time": 783,
      "status": {
        "lookupCode": "COMPLETED_SUCCESS",
        "displayValue": "Completed Successfully",
        "id": 3023215314,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PEFORMANCE_DEBUGGER_STATUS%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues/3023215314"
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com.com/rest/v19/performanceDebugger/3023233987"
        }
      ]
    }, {
      "referenceLabel": "test1:productLine1:model1",
      "description": "configure output test",
      "error": null,
      "action": {
        "lookupCode": "CONFIG_UPDATE",
        "displayValue": "Configuration Update",
        "id": 3023215311,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PERFORMANCE_DEBUGGER_ACTION%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com.com//rest/v19/lookupValues/3023215311"
          }
        ]
      },
      "id": 3023234032,
      "time": 121,
      "status": {
        "lookupCode": "COMPLETED_SUCCESS",
        "displayValue": "Completed Successfully",
        "id": 3023215314,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PEFORMANCE_DEBUGGER_STATUS%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com.com/rest/v19/lookupValues/3023215314"
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com.com/rest/v19/performanceDebugger/3023234032"
        }
      ]
    }
  ]
}

Back to Top