North Connectors

Search files in cache, error and archive folders

Changed on

Searches for files in the north connector cache

get/api/north/{northId}/cache/search

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/north/{northId}/cache/search
  • Auth: none required

Path parameters

northIdstring 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

  • bb7c469357f8Revision changes
    • breaking

      added the new required query request parameter maxNumberOfFilesReturned

    • breaking

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

    • warning

      deleted the query request parameter folder

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • a291063e086bRevision changes
    • breaking

      added the new required query request parameter folder

    • breaking

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

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the query request parameter maxNumberOfFilesReturned