Go to main content

Oracle® Advanced Support Platform Ticket Exchange Service Model and Specification API User Guide

Exit Print View

Updated: December 2023
 
 

POST Request Format

A POST request queries an incident related to an external customer created in the Oracle system.

The endpoint is https://amr.oracle.com/api/tes/incidents/search.

The request payload is a JSON object containing the search criteria.

A sample POST request is as follows:

{
  "criteria": {
    "connectBy": "AND",
    "expressions": [
      {
        "name": "startTime",
        "operator": "GREATER_OR_EQUAL",
        "value": "1668319048000"
      },
      {
        "name": "endTime",
        "operator": "LESS_OR_EQUAL",
        "value": "1700208365000"
      }
    ]
  },
  "fields": "summary,severity,description,action,incidentId,creationDate,status,externalId,primaryCI,worklog",
  "offset": "1",
  "limit": "-1",  // -1 means all records
  "sort": "+incidentid"
}

Where the values represent:

  • criteria: Filter criteria.

  • connectBy: Logical operator to connect multiple expressions (AND or OR).

  • expressions: An array of expressions, each specifying a condition for the search.

  • name: Name of the field to be searched.

  • operator: Comparison operator for the search (for example, GREATER_OR_EQUAL, LESS_OR_EQUAL). The valid values for this field include:

    • GREATER_THAN

    • GREATER_OR_EQUAL

    • LESS_OR_EQUAL

    • EQUALS

    • LESS_THAN

  • value: The value to compare against.

  • fields: Comma-separated list of fields to include in the response. Leave blank to get all the fields.

  • offset: Index of the first record to retrieve.

  • limit: Maximum number of records to retrieve. Use a valid positive value starting with 1. Set the value to -1 to retrieve all records.


    Note -  If a large number of records is being retrieved, it may take some time to complete the process.
  • sort: Sorting order for the results. Format: <field>+ for ascending order or <field>- for descending order.