History Queries

Search files in cache, error and archive folders

Searches for files in the history query cache

get/api/history/{historyId}/cache/search

Path parameters

historyIdstring required

Query parameters

nameContainsstring required
startstring required
endstring required
maxNumberOfFilesReturnednumber double required

Response

The cache search result

searchDatestring required

Represents an instant in time as an ISO 8601 string.

Example response

{
  "searchDate": "2023-10-31T12:34:56.789Z",
  "metrics": {
    "lastRunDuration": 1000,
    "lastRunStart": "2023-10-31T12:34:56.789Z",
    "lastConnection": "2023-10-31T12:34:56.789Z"
  },
  "error": [
    {
      "metadata": {
        "contentFile": "/path/to/content.json",
        "contentSize": 1024,
        "numberOfElement": 10,
        "createdAt": "2023-10-31T12:34:56.789Z",
        "contentType": "time-values"
      }
    }
  ],
  "archive": [
    {
      "metadata": {
        "contentFile": "/path/to/content.json",
        "contentSize": 1024,
        "numberOfElement": 10,
        "createdAt": "2023-10-31T12:34:56.789Z",
        "contentType": "time-values"
      }
    }
  ],
  "cache": [
    {
      "metadata": {
        "contentFile": "/path/to/content.json",
        "contentSize": 1024,
        "numberOfElement": 10,
        "createdAt": "2023-10-31T12:34:56.789Z",
        "contentType": "time-values"
      }
    }
  ]
}

Changes

Changed in 6 of the 89 revisions of this API.21411

  • bb7c469357f8215See the full diff
    • added the new required query request parameter maxNumberOfFilesReturned

      new-required-request-parameter

    • the response's body type changed from array to object for status

      response-body-type-changed

    • deleted the query request parameter folder

      request-parameter-removed

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a291063e086b71See the full diff
    • added the new required query request parameter folder

      new-required-request-parameter

    • the response's body type changed from object to array for status

      response-body-type-changed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • deleted the query request parameter maxNumberOfFilesReturned

      request-parameter-removed

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f7d0cb77f2c5215See the full diff
    • added the new required query request parameter maxNumberOfFilesReturned

      new-required-request-parameter

    • the response's body type changed from array to object for status

      response-body-type-changed

    • deleted the query request parameter folder

      request-parameter-removed

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the required property // from the response with the status

      response-required-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the // response's property type changed from string to no type for status

      response-property-type-changed

    • removed the required property // from the response with the status

      response-required-property-removed

    • added to the // response property anyOf list for the response status

      response-property-any-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new required query request parameter folder

      new-required-request-parameter

    • the response's body type changed from object to array for status

      response-body-type-changed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • deleted the query request parameter maxNumberOfFilesReturned

      request-parameter-removed

    This revision also has 219 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog