RESTful Server Runtime Management Interface for Oracle WebLogic Server

Search A Diagnostics Log

post

/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFAccessRuntime/WLDFDataAccessRuntimes/{name}/search

Search this diagnostics log, returning the results as json.

Request

Supported Media Types

application/json

Path Parameters

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Header Parameters

X-Requested-By(required): string

The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Must contain the following fields:

Root Schema : Search Criteria

Type: object

Title: Search Criteria

Show Source

fromId: integer(int64)

Only return records starting at this record id or later.
This can be used to continue a search that has more matching results than the specified limit field. The previous response will return a nextRecordId. Set fromId to that value and POST again to continue the search.
This field is optional.
lastMinutes: integer(int64)

Only return records that have been logged in the last n minutes.
This field is optional. If specified, the value must be greater than zero.
limit: integer(int64)

The maximum number of matching records that will be returned.
If there are more available records, then the response will contain the oldest matching records, as well as a nextRecordId that the client can use to continue the search (by setting fromId to its value).
This field must be specified. The value must be greater than zero.
query: string

An optional filter that can be used to restrict which records are returned, for example "SEVERITY = 'Info'". See "WLDF Query Language in Configuring and Using the Diagnostics Framework for Oracle WebLogic Server" for more details.
This field is optional. If not specified, then no filter is applied to the records.
since: string

Only return records that were logged at this time or later.
This field is optional. If specified it must be in one the following formats: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" (e.g. "2016-05-24T13:44:02.349-04:00"), "yyyy-MM-dd'T'HH:mm:ss.SSSXX" (e.g. "2016-05-24T13:44:02.349-0400") or "yyyy-MM-dd'T'HH:mm:ss.SSSX" (e.g. "2016-05-24T13:44:02.349-04").
until: string

Only return records that were logged earlier than this time.
This field is optional. If specified it must be in one the following formats: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" (e.g. "2016-05-24T13:44:02.349-04:00"), "yyyy-MM-dd'T'HH:mm:ss.SSSXX" (e.g. "2016-05-24T13:44:02.349-0400") or "yyyy-MM-dd'T'HH:mm:ss.SSSX" (e.g. "2016-05-24T13:44:02.349-04").

{
    "type":"object",
    "title":"Search Criteria",
    "properties":{
        "fromId":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Only return records starting at this record id or later. </p><p>This can be used to continue a search that has more matching results than the specified <code>limit</code> field. The previous response will return a <code>nextRecordId</code>. Set <code>fromId</code> to that value and POST again to continue the search.</p><p>This field is optional.</p>"
        },
        "lastMinutes":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Only return records that have been logged in the last n minutes.</p><p>This field is optional.  If specified, the value must be greater than zero.</p>"
        },
        "limit":{
            "type":"integer",
            "format":"int64",
            "description":"<p>The maximum number of matching records that will be returned.</p><p>If there are more available records, then the response will contain the oldest matching records, as well as a <code>nextRecordId</code> that the client can use to continue the search (by setting <code>fromId</code> to its value).</p><p>This field must be specified.  The value must be greater than zero.</p>"
        },
        "query":{
            "type":"string",
            "description":"<p>An optional filter that can be used to restrict which records are returned, for example \"SEVERITY = 'Info'\". See \"WLDF Query Language in Configuring and Using the Diagnostics Framework for Oracle WebLogic Server\" for more details.</p><p>This field is optional.  If not specified, then no filter is applied to the records.</p>"
        },
        "since":{
            "type":"string",
            "description":"<p>Only return records that were logged at this time or later.</p><p>This field is optional.  If specified it must be in one the following formats: \"yyyy-MM-dd'T'HH:mm:ss.SSSXXX\" (e.g. \"2016-05-24T13:44:02.349-04:00\"), \"yyyy-MM-dd'T'HH:mm:ss.SSSXX\" (e.g. \"2016-05-24T13:44:02.349-0400\") or \"yyyy-MM-dd'T'HH:mm:ss.SSSX\" (e.g. \"2016-05-24T13:44:02.349-04\").</p>"
        },
        "until":{
            "type":"string",
            "description":"<p>Only return records that were logged earlier than this time.</p><p>This field is optional.  If specified it must be in one the following formats: \"yyyy-MM-dd'T'HH:mm:ss.SSSXXX\" (e.g. \"2016-05-24T13:44:02.349-04:00\"), \"yyyy-MM-dd'T'HH:mm:ss.SSSXX\" (e.g. \"2016-05-24T13:44:02.349-0400\") or \"yyyy-MM-dd'T'HH:mm:ss.SSSX\" (e.g. \"2016-05-24T13:44:02.349-04\").</p>"
        }
    },
    "description":""
}

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Deployer: basic

Type: basic

Description: A user in the Deployer security role.
Monitor: basic

Type: basic

Description: A user in the Monitor security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Contains the matching log records.

Root Schema : Search Results

Type: object

Title: Search Results

Show Source

nextRecordId: string

Identifies the next matching record in the log.
This field is only present if there are more matching records than limit specified in the request body. The client can continue the search by POSTing the same query to this resource again, setting fromId to the value of nextRecordId, instead of specifying lastMinutes or since
records: array Items

Title: Items

The matching records. The records are in chronological order, oldest first.
All available fields are returned for each record. The list of available fields depends on the log.
If there are more matching records than limit specified in the request body, then the oldest matches up that that limit will be returned.

{
    "type":"object",
    "title":"Search Results",
    "properties":{
        "nextRecordId":{
            "type":"string",
            "description":"<p>Identifies the next matching record in the log.</p><p>This field is only present if there are more matching records than <code>limit</code> specified in the request body. The client can continue the search by POSTing the same query to this resource again, setting <code>fromId</code>  to the value of <code>nextRecordId</code>, instead of specifying <code>lastMinutes</code> or <code>since</code></p>"
        },
        "records":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"object",
                "title":"Record",
                "properties":{
                },
                "description":""
            },
            "description":"<p>The matching records. The records are in chronological order, oldest first.</p><p>All available fields are returned for each record.  The list of available fields depends on the log.</p><p>If there are more matching records than <code>limit</code> specified in the request body, then the oldest matches up that that limit will be returned.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

The matching records. The records are in chronological order, oldest first.

All available fields are returned for each record. The list of available fields depends on the log.

If there are more matching records than limit specified in the request body, then the oldest matches up that that limit will be returned.

Show Source

Array of: object Record

Title: Record

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"object",
        "title":"Record",
        "properties":{
        },
        "description":""
    },
    "description":"<p>The matching records. The records are in chronological order, oldest first.</p><p>All available fields are returned for each record.  The list of available fields depends on the log.</p><p>If there are more matching records than <code>limit</code> specified in the request body, then the oldest matches up that that limit will be returned.</p>"
}

Nested Schema : Record

Type: object

Title: Record

Show Source

{
    "type":"object",
    "title":"Record",
    "properties":{
    },
    "description":""
}

Examples

Start searching a log.

This example uses the POST method to start searching for records in the server log, returning the results as a json.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
  limit: 2,
  query: 'SEVERITY = \'Info''
}" \
-X POST http://localhost:7001/management/weblogic/latest/serverRuntime/WLDFRuntime/WLDFAccessRuntime/WLDFDataAccessRuntimes/ServerLog/search

Example Response

HTTP/1.1 200 OK

Response Body:
{
"records": [
{
  "RECORDID": 1,
  "DATE": "Sep 17, 2024, 4:28:34,715 PM Eastern Daylight Time",
  "SEVERITY": "Info",
  "SUBSYSTEM": "Default",
  "MACHINE": "machine1",
  "SERVER": "",
  "THREAD": "[STANDBY] ExecuteThread: '3' for queue: 'weblogic.kernel.Default (self-tuning)'",
  "USERID": "",
  "TXID": "",
  "CONTEXTID": "",
  "TIMESTAMP": "1726604914715",
  "MSGID": "BEA-000000",
  "MESSAGE": "JceConfig is unknown",
  "SUPP_ATTRS": "[severity-value: 64] ",
  "SEVERITY_VALUE": 64,
  "RID": ""
},
{
  "RECORDID": 2,
  "DATE": "Sep 17, 2024, 4:28:34,759 PM Eastern Daylight Time",
  "SEVERITY": "Info",
  "SUBSYSTEM": "Default",
  "MACHINE": "machine1",
  "SERVER": "",
  "THREAD": "[STANDBY] ExecuteThread: '3' for queue: 'weblogic.kernel.Default (self-tuning)'",
  "USERID": "",
  "TXID": "",
  "CONTEXTID": "",
  "TIMESTAMP": "1726604914759",
  "MSGID": "BEA-000000",
  "MESSAGE": "FIPS compliant operation not available for configuration type OTHER",
  "SUPP_ATTRS": "[severity-value: 64] ",
  "SEVERITY_VALUE": 64,
  "RID": ""
}],
"nextRecordId": 3
}

Continue searching a log.

This example uses the POST method to continue searching for records in the server log, returning the results as a json.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
  limit: 2,
  fromId: 3,
  query: 'SEVERITY = \'Info''
}" \
-X POST http://localhost:7001/management/weblogic/latest/serverRuntime/WLDFRuntime/WLDFAccessRuntime/WLDFDataAccessRuntimes/ServerLog/search

Example Response

HTTP/1.1 200 OK

Response Body:
{
"records": [
{
  "RECORDID": 3,
  "DATE": "Sep 17, 2024, 4:28:34,764 PM Eastern Daylight Time",
  "SEVERITY": "Info",
  "SUBSYSTEM": "Default",
  "MACHINE": "machine1",
  "SERVER": "",
  "THREAD": "[STANDBY] ExecuteThread: '3' for queue: 'weblogic.kernel.Default (self-tuning)'",
  "USERID": "",
  "TXID": "",
  "CONTEXTID": "",
  "TIMESTAMP": "1726604914764",
  "MSGID": "BEA-000000",
  "MESSAGE": "JceConfig is in non-FIPS mode",
  "SUPP_ATTRS": "[severity-value: 64] ",
  "SEVERITY_VALUE": 64,
  "RID": ""
},
{
  "RECORDID": 4,
  "DATE": "Sep 17, 2024, 4:28:35,167 PM Eastern Daylight Time",
  "SEVERITY": "Info",
  "SUBSYSTEM": "WebLogicServer",
  "MACHINE": "machine1",
  "SERVER": "",
  "THREAD": "Thread-6",
  "USERID": "",
  "TXID": "",
  "CONTEXTID": "",
  "TIMESTAMP": "1726604915167",
  "MSGID": "BEA-000377",
  "MESSAGE": "Starting WebLogic Server with Java HotSpot(TM) 64-Bit Server VM Version 17.0.12+8-LTS-286 from Oracle Corporation.",
  "SUPP_ATTRS": "[severity-value: 64] ",
  "SEVERITY_VALUE": 64,
  "RID": ""
}],
"nextRecordId": 5
}