v1/search

Search for DSNP content by id and filters, starting from `upperBound` block and going back for `blockCount` number of blocks

Changed on
post/v1/search

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

clientReferenceIdstring

An optional client-supplied reference ID by which it can identify the result of this search

upperBoundBlocknumber

The highest block number to start the backward search from

blockCountnumber required

The number of blocks to scan (backwards)

webhookUrlstring uri required

A webhook URL to be notified of the results of this search

Example request

{
  "upperBoundBlock": 100,
  "blockCount": 101,
  "filters": {
    "intentIds": [
      1,
      19
    ],
    "dsnpIds": [
      "10074",
      "100001"
    ]
  },
  "webhookUrl": "https://example.com"
}

Response

Returns a jobId to be used to retrieve the results

status100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 210 | 300 | 301 | 302 | 303 | 304 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 428 | 429 | 456 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 508 required

Status of search response

jobIdstring required

Job id of search job

Example response

{
  "jobId": "7b02edd742a653a3cf63bb0c84e43d3678aa045f"
}

Changes

    • ●

      removed the request property /////

    • ○

      added the new optional request property /////

    • ▲

      the ///// request property's minItems was increased to 1

    • ▲

      the ///// request property's minItems was increased to 1

    • ▲

      the request property format changed from no format to uri

    • ▲

      the response's property type changed from number to no type for status

    • ○

      api operation id SearchControllerV1_search removed and replaced with SearchControllerV1_search_v1

    • ○

      added to the response property allOf list for the response status

    • ○

      removed the 100.00 enum value from the response property for the response status

    • ○

      removed the 101.00 enum value from the response property for the response status

    • ○

      removed the 102.00 enum value from the response property for the response status

    • ○

      removed the 103.00 enum value from the response property for the response status

    • ○

      removed the 200.00 enum value from the response property for the response status

    • ○

      removed the 201.00 enum value from the response property for the response status

    • ○

      removed the 202.00 enum value from the response property for the response status

    • ○

      removed the 203.00 enum value from the response property for the response status

    • ○

      removed the 204.00 enum value from the response property for the response status

    • ○

      removed the 205.00 enum value from the response property for the response status

    • ○

      removed the 206.00 enum value from the response property for the response status

    • ○

      removed the 300.00 enum value from the response property for the response status

    • ○

      removed the 301.00 enum value from the response property for the response status

    • ○

      removed the 302.00 enum value from the response property for the response status

    • ○

      removed the 303.00 enum value from the response property for the response status

    • ○

      removed the 304.00 enum value from the response property for the response status

    • ○

      removed the 307.00 enum value from the response property for the response status

    • ○

      removed the 308.00 enum value from the response property for the response status

    • ○

      removed the 400.00 enum value from the response property for the response status

    • ○

      removed the 401.00 enum value from the response property for the response status

    • ○

      removed the 402.00 enum value from the response property for the response status

    • ○

      removed the 403.00 enum value from the response property for the response status

    • ○

      removed the 404.00 enum value from the response property for the response status

    • ○

      removed the 405.00 enum value from the response property for the response status

    • ○

      removed the 406.00 enum value from the response property for the response status

    • ○

      removed the 407.00 enum value from the response property for the response status

    • ○

      removed the 408.00 enum value from the response property for the response status

    • ○

      removed the 409.00 enum value from the response property for the response status

    • ○

      removed the 410.00 enum value from the response property for the response status

    • ○

      removed the 411.00 enum value from the response property for the response status

    • ○

      removed the 412.00 enum value from the response property for the response status

    • ○

      removed the 413.00 enum value from the response property for the response status

    • ○

      removed the 414.00 enum value from the response property for the response status

    • ○

      removed the 415.00 enum value from the response property for the response status

    • ○

      removed the 416.00 enum value from the response property for the response status

    • ○

      removed the 417.00 enum value from the response property for the response status

    • ○

      removed the 418.00 enum value from the response property for the response status

    • ○

      removed the 421.00 enum value from the response property for the response status

    • ○

      removed the 422.00 enum value from the response property for the response status

    • ○

      removed the 424.00 enum value from the response property for the response status

    • ○

      removed the 428.00 enum value from the response property for the response status

    • ○

      removed the 429.00 enum value from the response property for the response status

    • ○

      removed the 500.00 enum value from the response property for the response status

    • ○

      removed the 501.00 enum value from the response property for the response status

    • ○

      removed the 502.00 enum value from the response property for the response status

    • ○

      removed the 503.00 enum value from the response property for the response status

    • ○

      removed the 504.00 enum value from the response property for the response status

    • ○

      removed the 505.00 enum value from the response property for the response status