Message Searches

The search parameter data object structure as follows:

• sortOrder - [enumerated string] ASCENDING or DESCENDING for the order in which the search is run, the default being DESCENDING.
• maxResults - [int] the maximum number of search results to return - no more than the default of 1000.
• receivedTimeRange - [object] defaults to no time restrictions - either a start/end time or a duration can be provided but not both.
  • startTime - [str] date-time in ISO8601 format.
  • endTime - [str] date-time in ISO8601 format.
  • duration - [str] ISO8601 format duration relative to the current date/time.
• receivedBy - [array] of numbers representing communication point identifiers of the communication points that the messages must have been received by (defaults to all communication points).
• messageTableArrivalTimeRange - [object] defaults to no time restrictions - either a start/end time or a duration can be provided but not both.
  • startTime - [str] date-time in ISO8601 format.
  • endTime - [str] date-time in ISO8601 format.
  • duration - [str] duration in ISO8601 format relative to the current date-time.
• sentFrom - [array] of numbers representing communication point identifiers of the communication points that sent the messages to the error queue - defaults to all communication points.
• routes - [array] of numbers representing route identifiers of the routes that sent the messages to the error queue (defaults to all routes).
• fullText - [object] defaults to no full text search.
  • mode - [enumerated string] CASE_SENSITIVE, CASE_INSENSITIVE, or REGULAR_EXPRESSION.
  • value - [str] value to search for.
• properties - [array] of message properties to search on.
  • name - [str] name of the property to search on.

  • value - [str] property value to search for.

    In each field in the data model, all search parameters are optional and provide for defaults (or are not used in some cases). Consequently, an empty JSON object ({}) is a set of valid search parameters.

    If message properties are used as search parameters then these must be indexed against the output message in order to match (the indexes are written as the message arrives on the error or hold queue).

201 Created - redirect with the location header set to the result set URL:

{
  "data":{
    "state":"COMPLETED",
    "limitedByDataValidation":false,
    "results":[
       {
         "timestamp":"20121005T120107\u002E415\u002B1300",
         "messageIdentifier":"1\u002E621952\u002E9318",
         "rootMessageIdentifier":"1\u002E621952\u002E9312"
       },
       {
         "timestamp":"20121005T120105\u002E440\u002B1300",
         "messageIdentifier":"1\u002E622208\u002E9335",
         "rootMessageIdentifier":"1\u002E622208\u002E9313"
       },
       {
         "timestamp":"20121005T120103\u002E401\u002B1300",
         "messageIdentifier":"1\u002E611712\u002E9210",
         "rootMessageIdentifier":"1\u002E611712\u002E9205"
       },
    ],
    "searchTime":"PT0\u002E006S",
    "completionTime":"20121017T111121\u002E371\u002B1300",
    "moreResults":false,
    "previousUri":"https://localhost:8444/api/search/resultset/2/previous"
  },
  "error":null
}

201 Created - redirect with the location header set to the result set URL:

{
  "data":{
    "state":"COMPLETED",
    "limitedByDataValidation":false,
    "results":[
      {
        "timestamp":"20121005T120026\u002E638\u002B1300",
        "messageIdentifier":"1\u002E410240\u002E7051",
        "rootMessageIdentifier":"1\u002E410240\u002E7046"
      },
      {
        "timestamp":"20121005T120024\u002E934\u002B1300",
        "messageIdentifier":"1\u002E396672\u002E6815",
        "rootMessageIdentifier":"1\u002E396672\u002E6809"
      },
      {
        "timestamp":"20121005T115939\u002E436\u002B1300",
        "messageIdentifier":"1\u002E31488\u002E365",
        "rootMessageIdentifier":"1\u002E31488\u002E358"
      }
    ],
    "searchTime":"PT0\u002E013S",
    "completionTime":"20121017T112044\u002E447\u002B1300",
    "moreResults":false,
    "previousUri":"https://localhost:8444/api/search/resultset/3/previous"
  },
  "error":null
}

A successful search is returned with the following data object structure:

• state - [enumerated string] state of the search ([enum] RUNNING, COMPLETED, CANCELLED).
• moreResults - [bool] false if and only if we know that there are no additional results to be found as of the time that the search was run; true if we know that there are more results or are not sure. This is not defined if the search is either still running or was canceled.
• limitedByDataValidation - [bool] true if the results have been limited due to ongoing message store data validation.
• completionTime - [str] date-time in ISO8601 format representing the date/time that the search completed.
• searchTime - [str] duration in ISO8601 format representing the time the search took to run).
• nextUri - [str] URL to use to start the next search - /api/search/resultset/<id>/next. Not included if we know that there are no more results.
• previousUri - [str] URL to use to start the next search - /api/search/resultset/<id>/previous.
• results - [array] of search results.
  • messageIdentifier - [str] message identifier.
  • rootMessageIdentifier - [str] root message identifier.
  • timestamp - [str] date-time in ISO8601 format representing the timestamp for the message: input time for input searches; output time for output searches; route received time for intermediate messages; arrival time on the message table for errored and held messages).
  • receivedTimestamp - [str] date-time in ISO8601 format representing the time that the message was originally received by Rhapsody. Not provided for messages migrated from Rhapsody 3.3 or earlier.
  • component - [object] information about the component associated with the message: the input communication point for input messages; the output communication point for output messages; the route for intermediate messages; the previous component to process the message for errored and held messages.
    • id - [int] component identifier.
    • name - [str] component name.
    • folderPath - [str] the folder path, and also the route name if this is a filter.
  • source - [object] information about the communication point that original received the message.
    • id - [int] communication point identifier.
    • name - [str] containing the communication point name.
    • folderPath - [str] the folder path.
  • nextDestination- [object] information about the component that is intended to process the message next: for intermediate messages this is the next filter to process the message; for errored and held messages this is the component that sent them to the error/hold queue; this is not provided for input or output searches.
    • id - [int] component identifier.
    • name - [str] component name.
    • folderPath - [str] component folder path including route name if this component is a filter.
  • errorDetails - [str] the Error Details for an errored message in the Error Queue as displayed in the Management Console.
  • properties - [array] values of indexed properties explicitly asked for in the request where a value exists for this message.
    • name - [str] property name.
    • value - property value.

Example

{
    data: {
        state: " COMPLETED",
        moreResults: false,
        limitedByDataValidation: false,
        completionTime: "20171204T100225.945+1300",
        searchTime: "PT0.003S",
        previousUri: "https://localhost:8444/api/search/resultset/1",
        results: [ 
          {
            messageIdentifier: "1.8576.23",
            rootMessageIdentifier: "1.8576.21",
            timestamp: "20171204T094400.099+1300",
            errorDetails: "Sent from error filter"
          },
          {
            messageIdentifier: "1.8192.20",
            rootMessageIdentifier: "1.8192.18",
            timestamp: "20171204T094355.075+1300",
            errorDetails: "Sent from error filter"
          },
          {
            messageIdentifier: "1.7808.17",
            rootMessageIdentifier: "1.7808.15",
            timestamp: "20171204T094350.088+1300",
            errorDetails: "Sent from error filter"
          }
       ]
    },
    error : null
}

Retrieves a list of all result sets for the current user that have been started from the REST API (including those started from other HTTP sessions).

Returns an array of result sets each with the following data object structure:

• uri - [str] URI pointing to the result set.
• state - [enumerated string] RUNNING, COMPLETED, CANCELLED, or FAILED.
• searchTime - [str] duration in ISO8601 format indicating how long the search took to run or how long it has been running.
• type - [enumerated string] ERROR_QUEUE, or HOLD_QUEUE.
• completionTime - [str] date-time in ISO8601 format indicating when the search was completed, canceled or failed (not provided if the search is still running).
• resultCount - [int] number of results found so far for this search.

The URI returned for each result set is of the form /api/search/resultset/<id> so can be used by the caller to either retrieve the results or purge it. The returned URI cannot be used by any other user as each user effectively has their own URI space for result sets.

Example

Informs the server that the specified result set is no longer required and can be discarded. The server automatically discards result sets to save on memory and disk usage after a period of inactivity, or if the maximum number of result sets per user or globally are reached.

Removes all result sets for the calling user. This is the same as performing an explicit delete on each individual result set.

Retrieves a list of all result sets started via the REST API for all users.

An array of result sets each with the following data object structure:

• user - [str] username.
• resultSets - [array] of result sets.

The resultset objects are identical to those returned from /api/search/resultset for a specific user, except that the URIs for each result set are different (they are in the form /api/search/admin/resultset/<id>), allowing them to be subsequently used in admin operations (in other words, cancel and discard the search). Note that there is no way for a caller of this API method to use the returned result set URIs to use those URIs to retrieve the search results, unless they were started by that user (in other words, even though an admin can cancel searches for another user they cannot view search results for another user).

Example