Jump to

• Request
• Response

Search A Diagnostics Log

post

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/WLDFPartitionRuntime/WLDFPartitionAccessRuntime/WLDFDataAccessRuntimes/{name}/search

Search this diagnostics log, returning the results in the same text format as the corresponding server-side log files.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: 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'.

Body ()

Must contain the following fields:

Root Schema : Search Criteria

Type: object

Title: Search Criteria

Show Source

• fromId(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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.

Back to Top

Response

Supported Media Types

• text/plain

200 Response

Returns the matching records in the same text format as the corresponding server-side log files. The records are in chronological order, oldest record first.

If there are more matching records than limit specified in the request body, then the oldest limit matching records are returned, and an extra line is added to the response in the form nextRecordId=nnn. It contains the record id of the next matching record. 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

Body ()

Root Schema : Results

Type: string

Title: Results

Back to Top